arichar6 / turbopy Goto Github PK

The documentation for turboPy is currently a mess (my bad!) and needs to be cleaned up, created where missing, and completed. This will involve using docstrings using the numpydoc format.

Docstrings need to be added for:

• The module
• The classes
• The class methods

This should tie into the documentation effort mentioned in #1, and will enable automatic creation of much of the documentation that will end up on readthedocs.

• add some unit tests
• connect to TravisCI (on padamson account)
• verify triggering of automated tests (on padamson account)
• connect to TravisCI (on arichar6 account)
• add CONTRIBUTING w/info on testing
• add some documentation with Sphinx
• connect to readthedocs.org
• verify triggering of automated update to docs/docstrings
• update CONTRIBUTING w/info on docs

It is desirable for the xarray outputs from turbopy to be restructured to make them more useful to those who wish to work with the outputs. A specific example of this is 2D data with dimensions of space and time do not have either real time or spatial dimension as the coordinate dimension. This makes them unavailable for some of xarray's indexing features.

It is possible that this could involve an overhaul to the way in which turbpy handles information during computation and its output.