-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify if this is meant to be command-line only or also python-useable #5
Comments
(This is part of the review in openjournals/joss-reviews#182) |
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 (lime-rt/lime#33). This should be done this coming week. |
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!) |
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. |
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? |
Thanks, it is OK to leave this issue open. |
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).
The text was updated successfully, but these errors were encountered: