<div dir="ltr">In case it hasn't been mentioned, I would recommend a documentation strategy that can parse your code and including comments and arguments from functions, etc. If you use <a href="http://read-the-docs.readthedocs.io/en/latest/getting_started.html">read the docs</a> you can have the build happen automatically with pushes to the repo, and it's a familiar, clean interface.</div><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Jun 16, 2016 at 6:44 AM, Frederick, Blaise B. <span dir="ltr"><<a href="mailto:bbfrederick@mclean.harvard.edu" target="_blank">bbfrederick@mclean.harvard.edu</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">



<div style="word-wrap:break-word">
Hi all,
<div><br>
</div>
<div>For the last few years my lab has been doing time delay analysis on fMRI and concurrent fMRI/NIRS data, and I’ve written a number of python tools for performing the analysis, and they’ve been refined for several years at this point, and I think
 they could be generally useful to people, so I’m looking to release the software.  I’m fairly new at this, and I’ve found a bunch of recommendations on how to do this, some of which are contradictory.  I’d appreciate any help I could get on this.</div>
<div><br>
</div>
<div>What I’ve done so far:</div>
<div>1) Chosen a license (Apache 2, based on a lot of reading and some conversations)</div>
<div>2) Put the core programs up on github (<a href="https://github.com/bbfrederick/delaytools" target="_blank">https://github.com/bbfrederick/delaytools</a>)</div>
<div>3) Tried to put together rudimentary documentation and installation directions.</div>
<div><br>
</div>
<div>As things exist now, if you install the prerequisites, download the code, and add the main directory to your path, you should be able to run the tools, which is a fine start, but there seems to be a lot more to installation than that (automatically
 installing dependancies and all that) that I’m unable to figure out. I’d appreciate any feedback on this.  I’m a little mystified by the vagaries of constructing a setup.py file, and what constitutes a ‘package’ and a ‘module’.</div>
<div><br>
</div>
<div>Some of the questions I have:</div>
<div>1) In addition to the main program, I have scads of command line utilities that make preparing and interpreting the data easier - do I just put them all in the top level directory, or in a bin directory?</div>
<div>2) The dependancies for the majority of the tools are very simple (numpy, scipy, scikits-learn, matplotlib, nibabel), but there’s a kind of useful gui tool that requires pyqt4 and pyqtgraph - pyqt does not seem to be installable with pip, so I’m
 not sure how to handle that (installing it all with anaconda is easy though). How should I handle this?</div>
<div>3) What’s the best way to publicize this?  This won’t be useful if nobody can find it.</div>
<div><br>
</div>
<div>Thanks,</div>
<div>Blaise</div>
<div><br>
</div>
<div>
<div>
<div>
<div style="text-align:-webkit-auto;word-wrap:break-word">
--------------<br>
Blaise Frederick<br>
Associate Professor of Psychiatry/Biophysicist<br>
Harvard Medical School/McLean Hospital<br>
<a href="mailto:bbfrederick@mclean.harvard.edu" target="_blank">bbfrederick@mclean.harvard.edu</a></div>
<div style="text-align:-webkit-auto;word-wrap:break-word">
<a href="http://www.nirs-fmri.net" target="_blank">http://www.nirs-fmri.net</a><br>
</div>
</div>
<div><br>
</div>
<br>
</div>
<br>
</div>
<p></p>

<p>The information in this e-mail is intended only for the person to whom it is<br>
addressed. If you believe this e-mail was sent to you in error and the e-mail<br>
contains patient information, please contact the Partners Compliance HelpLine at<br>
<a href="http://www.partners.org/complianceline" target="_blank">http://www.partners.org/complianceline</a> . If the e-mail was sent to you in error<br>
but does not contain patient information, please contact the sender and properly<br>
dispose of the e-mail.</p></div>

<br>_______________________________________________<br>
Neuroimaging mailing list<br>
<a href="mailto:Neuroimaging@python.org">Neuroimaging@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/neuroimaging" rel="noreferrer" target="_blank">https://mail.python.org/mailman/listinfo/neuroimaging</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature">Vanessa Villamia Sochat<br>Stanford University<br><div><div><div>(603) 321-0676</div></div></div></div>
</div>