Website documentation - Githubissues

mantle-convection-constrained / terratools

Tools to read, analyse and visualise models written by the TERRA mantle convection code

https://terratools.readthedocs.io/en/latest/

MIT License

7 stars 5 forks source link

Website documentation #32

Closed anowacki closed 7 months ago

anowacki commented 2 years ago

We need documentation containing doctests (to ensure it doesn't go out of date) that explains what the package is for and how to use it.

Some jobs include:

[x] Installation instructions (maybe wait for PyPI registration)
- [x] Include note about needing to install Cartopy dependencies in some situations (#30)
[x] General introduction to TERRA models, the file formats and the mesh (JP; JHD) (#132)
[x] Outline of the main classes and modules:
- [x] TerraModel (AN) (#112)
- [x] SeismicLookupTable (JWa)
- [x] properties and submodules/classes (RM)
[x] Examples: #43