-
Notifications
You must be signed in to change notification settings - Fork 6
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
JOSS-REVIEW: documentation #49
Comments
in addition to this: |
good idea, i'll add a jupyter notebook with the tutorial inside it |
@thurber Since you're working on the documentation, just wanted to remind you to update the installation instructions (using Python 3.7+) |
I added a Jupyter notebook tutorial in pull request #50! |
addressed by #50 |
documentation in general is improved.
|
hi @thurber,
i find the documentation overall good, but also pretty concise.
it would be great to include a jupyter notebook with an example application of your model.
this would not only give users an idea how a typical model workflow would look like, but also provide you with an opportunity to explain the model's functionality and set-up step-by-step and in greater detail.
i furthermore would like to see a 'statement of need' (similar as in the paper) in the documentation. not everyone is going to read the paper, but many will just go through the readme or rtd.
reference to: openjournals/joss-reviews#3221.
The text was updated successfully, but these errors were encountered: