Documentation - Githubissues

boutproject / hypnotoad

Python grid generator for BOUT++ https://hypnotoad.readthedocs.io/en/latest/

GNU General Public License v3.0

11 stars 3 forks source link

Documentation #4

Open johnomotani opened 4 years ago

johnomotani commented 4 years ago

Need some documentation.

At least:

[x] how-to run hypnotoad2 to create tokmak (or TORPEX X-point) grids
[x] description of what all the options that can be set in .yaml input files do

Would be nice to have:

[x] notes on common problems when gridding (e.g. grid goes over the edge of the input psi-grid, etc.) and hints on how to resolve
[x] use ~~click to get command line options, so we can~~~~sphinx-argparse to document the options and provide help and usage instructions.
[ ] a derivation and explanation of non-orthogonal coordinate system and implementation.

johnomotani commented 3 years ago

Here are some notes I made on non-orthogonal coordinates for BOUT++/hypnotoad, which need checking and adding to the documentation here and/or on https://github.com/boutproject/BOUT-dev NonOrthogonalBOUTCoords_new.pdf