[Insight-developers] [Insight-users] Submit ITK modules to Insight Journal

[Xiaoxiao Liu]

On Wed, Apr 3, 2013 at 1:04 PM, Bradley Lowekamp <blowekamp at mail.nih.gov>wrote:

> Xiaoxiao,
>
> I was looking at the instructions for the source module:
>
>
> https://github.com/InsightSoftwareConsortium/InsightJournalTemplate/tree/ModularTemplate/Source
>
> It looks like I need to copy my current ITK Module into this IJ Template
> directory, then copy it back into ITK to build it... Seems like too much
> coping.
>
>

> Say I have a module I have been using and want to write an IJ article on
> it:
>
> https://github.com/blowekamp/itkOBBLabelMap
>
> Could I just add a submodule in the Source directory? Do I have to use the
> "MyIJSubmission" for the name of my module?
>
>
>> You don't need to copy your ITK module into the IJ template directory.
You should be able to just upload the module folder "*itkOBBLabelMap"* as
it is, no need to use "MyIJSubmission".  Take a look at the LSTK
example<http://www.insight-journal.org/browse/publication/869>,
look into the zip file, you will see.   I will update the instructions to
make it clear.


> Would something like the following work:
> git clone --origin template git at github.com:InsightSoftwareConsortium/InsightJournalTemplate.git
> ijOBBLabelMap
> cd  ijOBBLabelMap
> git submodule add https://github.com/blowekamp/itkOBBLabelMapSource/itkOBBLabelMap
>
> * >> Why you are using submodule here? Right now, we still require
contributors to upload the code tar ball instead of providing a git url. It
is an excellent idea though to use a git repo link instead. This will need
some extra work on the IJ server end. Let me check how difficult it is and
report back.*
* *

> Thanks,
> Brad
>
>
>
> On Apr 3, 2013, at 12:08 PM, Xiaoxiao Liu <xiaoxiao.liu at kitware.com>
> wrote:
>
> Hi All,
>
> Just want to let you know that our favorite open-source journal the Insight
> Journal <http://www.insight-journal.org/>
> now supports *ITK module* submissions.
>
> The modular code template can be found at:
> http://www.insight-journal.org/help/submission
>
> Here is an example of the ITK module submission:
>   http://www.insight-journal.org/browse/publication/869
> with the dashboard testing results<http://open.cdash.org/viewTest.php?buildid=2837728>shown on the review page.
>
> Newly submitted  ITK modules will be tested with ITK 4.3.1 for now,  and
> hopefully will soon be tested with  latest release version of ITK at the
> time of submission.
>
> The main advantages of organizing your code into a ITK module (using the
> itk module macros in the CMake code) for IJ submission are:
> 1) Make it easier to integrate your code into ITK proper later. The
> modular structure makes you to think about the module dependencies and
> categorization of your code earlier on.
> 2) Make it easy to share your cool contribution to the community via the ITK
> Remote Module distribution mechanism<http://www.itk.org/Wiki/ITK/Policy_and_Procedures_for_Adding_Remote_Modules> :
> other ITK users/developers can fetch your code remotely by switching on a
> CMake variable at build time.
> 3) Testing is easy when utilizing the testing infrastructure  (providing
> image comparisons) in ITK, just follow the example provided in the modular
> template.
>
> Please let me know if you see problems or need help when submitting your
> modular ITK code.
> Thanks.
>
> --Best
> Xiaoxiao
> ---------------------------------------------
> *Xiaoxiao Liu*, Ph.D.
> R & D Engineer
> Kitware Inc <http://www.kitware.com/>.
> Clifton Park, NY
> Phone: (518) 881-4924  or  (518) 371-3971 x124
>
>  _____________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Kitware offers ITK Training Courses, for more information visit:
> http://www.kitware.com/products/protraining.php
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-users
>
>
>


-- 


---------------------------------------------
*Xiaoxiao Liu*, Ph.D.
R & D Engineer
Kitware Inc <http://www.kitware.com/>.
Clifton Park, NY
Phone: (518) 881-4924  or  (518) 371-3971 x124
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.itk.org/pipermail/insight-developers/attachments/20130403/232c78ea/attachment.htm>