Home

Welcome developers,

This wiki contains document design decisions and other package information pertinent to the development of TMIN. To keep tmin a clean, organized open source project, it is essential that meticulous release notes and candidate submission instructions be thoroughly documented to maintain a procedural approach to introducing new improvements into TMIN's core functionality. Please note that user documentation does not belong here. All user documentation should go in the user manual that is part of the distribution.

Developer documentation:

Release notes - information on past and future releases of the package

Release instructions - what needs to be done to release a new version of the package

Setup development environment with conda - quick start for development

How to contribute with a pull request - How to create a pull request and keep it up to date with the main branch

Developer notes - package structure, naming conventions, docstring format, etc

Testing conventions - constructing unit tests (and examples)

User documentation: