Contributions to PyCO2SYS from anyone are very welcome, but please read this first!
If you would like a new feature to be added to PyCO2SYS, or if you find a bug or error in any of its calculations, then please first share this as an issue. Please do this regardless of whether you are able to solve the issue yourself, to help to avoid duplicate work.
If you would like to add or edit something directly then please make a fork of PyCO2SYS, make your changes, and submit the updates back with a pull request, noting the comments below. If you are frequently making lots of contributions, you could also be given direct access to the main repo.
Please add a comment on the corresponding issue to say that you are working on that problem.
The main branch contains the most recent release, and nothing more. Please do not submit pull requests directly to main.
The develop branch is where the next version is being prepared. When you have something ready to add, please submit your pull request to develop. You may also wish to make your new fork from develop to be sure you are using the latest version.
Every module and function must have at least a simple docstring. I am in the process of updating the docstrings to follow the numpydoc format, so please follow this for any new additions.
Functions that are "private" and not intended to be used by the typical end user should begin with an underscore. These still require a docstring.
For readable consistency with minimal effort, everything in PyCO2SYS (except for the module PyCO2SYS.original, for consistency with its MATLAB predecessor) will be reformatted by Black before each new release.
Anyone making a substantial contribution will be invited to join the list of authors for the Zenodo citation.
Documentation is available at PyCO2SYS.readthedocs.io. This site is automatically generated after each commit from the files in the docs directory on main using Material for MkDocs. The docs on develop are also automatically generated after each commit to that branch and can be seen at mvdh.xyz/PyCO2SYS.
There is a repo of PyCO2SYS examples as Jupyter Notebooks, which you can add to at PyCO2SYS-examples.
If you add new features to PyCO2SYS, please also propose some sort of documentation for them in one of these formats.
Any changes that you make should be added to appropriate set of release notes in the version history and any related citations added to the references.
A very approximate plan of future additions to the code, and the person leading their implementation (get in touch with them to contribute):
- Add validity checker for temperature, salinity and pressure conditions (see #25).
- Integrate with Pytzer (mvdh7).
- Air-sea CO2 flux calculations.
- Alkalinity titration solvers - use e.g. Calkulate.