DOC: Add information about citing Py-ART in publications

[jjhelmus]

No description provided.

[jjhelmus]

@scollis Let me know if you like the message used here, it can be adjusted as needed.

When Py-ART is imported a short message will be printed providing information on how to properly cite the software in publications. For example:

$ python -c "import pyart"

## You are using the Python ARM Radar Toolkit (Py-ART), an open source
## library for working with weather radar data.
##
## If you use this software to prepare a publication, please cite:
##
##     JJ Helmus and SM Collis, JORS 2016, doi: 10.5334/jors.119
$

This message will be suppressed if the PYART_QUIET variable exists in the evironment:

$ PYART_QUIET= python -c "import pyart"
$

[jjhelmus]

For reference C. Titus Brown has a blog post on how his group adds text like this to khmer to encourage citing of the software. I decided against adding a CITATION file to the repository as this idea does not seem to have taken off in the scientific python community.

[scollis]

Great but use
PYART_QUIET
-sent from a mobile device-

On Aug 3, 2016, at 4:30 PM, Jonathan J. Helmus notifications@github.com wrote:

@scollis Let me know if you like the message used here, it can be adjusted as needed.

When Py-ART is imported a short message will be printed providing information on how to properly cite the software in publications. For example:

$ python -c "import pyart"

You are using the Python ARM Radar Toolkit (Py-ART), an open source

library for working with weather radar data.

If you use this software to prepare a publication, please cite:

JJ Helmus and SM Collis, JORS 2016, doi: 10.5334/jors.119

$
This message will be suppressed if the PYART_QUITE variable exist in the evironment:

$ PYART_QUITE= python -c "import pyart"
$
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

[jjhelmus]

Updated commit to use PYART_QUIET. Apparently I could not spell correctly yesterday, thanks @scollis for point that out.