search

migueldvb / cine

Calculate infrared pumping rates by solar radiation
MIT License
3 stars 1 forks source link

Clarify if this is meant to be command-line only or also python-useable #5

Open eteq opened 7 years ago

eteq commented 7 years ago

From the first part of the README I get the impression that I'm supposed to use this as a Python library. But then the example suggests this is meant to be a command-line code. That should be clarified.

Also, if it's supposed to be used as a library, there needs to be more documentation (can say more if that's the case).

eteq commented 7 years ago

(This is part of the review in openjournals/joss-reviews#182)

migueldvb commented 7 years ago

At this point it is only useful to run the code using the command line tool... Nevertheless I will generate some documentation using sphinx as this may be useful to combine the fluorescence calculation in python models to be used in the LIME radiative transfer code when this functionality is available (https://github.com/lime-rt/lime/pull/33).

This should be done this coming week.

eteq commented 7 years ago

OK, great, @migueldvb. In that case, the only part I think is necessary at this point (for the paper) is to note in the README that it's primarily intended to be a command-line tool. (But your idea of adding docs w/sphinx is a nice bonus!)

migueldvb commented 7 years ago

I have reworded the README file to make clear that this is supposed to be used as a command-line script for the moment. At this point this is the only useful way to generate pumping rates as input for molecular excitation and radiative transfer, but will be glad to add the docs for helping with integration with other codes.

eteq commented 7 years ago

OK, cool. I think this satisfies the review requirement.

Do you want to leave this open to remind you to add the integration docs, @migueldvb, or should we close this and make a new one?

migueldvb commented 7 years ago

Thanks, it is OK to leave this issue open.