Skip to content
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

Actually (re-)write introductory and conceptual documentation #61

Closed
1 of 9 tasks
axch opened this issue Mar 14, 2017 · 2 comments · Fixed by #91
Closed
1 of 9 tasks

Actually (re-)write introductory and conceptual documentation #61

axch opened this issue Mar 14, 2017 · 2 comments · Fixed by #91

Comments

@axch
Copy link
Collaborator

axch commented Mar 14, 2017

Presumably this will have a lot of overlap with the paper.

Components:

  • Purpose and summary.
  • Advertising (it's fast, it's easy to install and configure).
  • Installation instructions.
  • Usage examples (Issue Make the user-facing examples complete #23).
  • What equations does the model solve?
  • Numerical description: name of integration method, grid type, any other considerations.
  • Maybe pointer to developer documentation, produced by Doxygen.
  • Maybe pointer to auto-built test/example results, per Automatically build (some of the) documentation #65.
  • Comment that there is a separate Fortran program under all the Python, which can be invoked standalone profitably enough.
@axch axch added the usability label Mar 14, 2017
@axch axch added this to the Draft the MIM paper for Geoscientific Modeling milestone Mar 14, 2017
@edoddridge
Copy link
Owner

Definitely a lot of overlap, but also some quite different content. For example, I don't expect the paper to describe the installation procedure in detail.

@axch
Copy link
Collaborator Author

axch commented Mar 27, 2017

The ideal installation instructions are "pip install aronnax", which, to be true, calls for #87 being done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants