Metadata-Version: 2.1
Name: PyCO2SYS
Version: 1.7.0.1
Summary: PyCO2SYS: marine carbonate system calculations in Python
Home-page: https://github.com/mvdh7/PyCO2SYS
Author: Humphreys, Matthew P. and Sandborn, Daniel E. and Gregor, Luke and Pierrot, Denis and van Heuven, Steven M. A. C. and Lewis, Ernie R. and Wallace, Douglas W. R.
Author-email: m.p.humphreys@icloud.com
License: UNKNOWN
Description: # PyCO2SYS
        
        ![Tests](https://github.com/mvdh7/PyCO2SYS/workflows/Tests/badge.svg?branch=develop)
        [![pypi badge](https://img.shields.io/pypi/v/PyCO2SYS.svg?style=popout)](https://pypi.org/project/PyCO2SYS/)
        [![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.3744275-informational)](https://doi.org/10.5281/zenodo.3744275)
        [![Docs](https://readthedocs.org/projects/pyco2sys/badge/?version=develop&style=flat)](https://pyco2sys.readthedocs.io/en/develop/)
        [![Coverage](https://github.com/mvdh7/PyCO2SYS/blob/develop/.misc/coverage.svg)](https://github.com/mvdh7/PyCO2SYS/blob/develop/.misc/coverage.txt)
        [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        
        **Contents:**
        
        - [PyCO2SYS](#pyco2sys)
          - [Introduction](#introduction)
          - [Citation](#citation)
          - [Installation](#installation)
          - [Basic use](#basic-use)
          - [About](#about)
          - [License](#license)
        
        ## Introduction
        
        **PyCO2SYS** is a Python implementation of CO2SYS, based on the [MATLAB v2.0.5](https://github.com/jamesorr/CO2SYS-MATLAB) but also including the updates made for [MATLAB CO2SYS v3](https://github.com/jonathansharp/CO2-System-Extd) as well as some additional related calculations.  PyCO2SYS solves the full marine carbonate system from the values of any two of its parameters.
        
        Every combination of input parameters has been tested, with differences in the results small enough to be attributable to floating point errors and iterative solver endpoint differences (i.e. negligible).  See the scripts in [validate](https://github.com/mvdh7/PyCO2SYS/tree/master/validate) to see how and check this for yourself, and their [discussion](https://pyco2sys.readthedocs.io/en/latest/validate/) in the online docs.  **Please [let us know](https://github.com/mvdh7/PyCO2SYS/issues) ASAP if you discover a discrepancy that we have not spotted!**
        
        Documentation is available online at [PyCO2SYS.readthedocs.io](https://pyco2sys.readthedocs.io/en/latest/).
        
        There are also some usage examples that you can either download or run live in your web browser (with no Python installation required) at [PyCO2SYS-examples](https://github.com/mvdh7/PyCO2SYS-examples#pyco2sys-examples).
        
        ## Citation
        
        The citation for PyCO2SYS alone is:
        
        > Humphreys, M. P., Sandborn, D. E., Gregor, L., Pierrot, D., van Heuven, S. M. A. C., Lewis, E. R., and Wallace, D. W. R. (2021).  PyCO2SYS: marine carbonate system calculations in Python.  *Zenodo.*  [doi:10.5281/zenodo.3744275](https://doi.org/10.5281/zenodo.3744275).
        
        The DOI refers to all versions of PyCO2SYS.  Please also specify the version number that you used.  You can find this in Python with:
        
        ```python
        import PyCO2SYS as pyco2
        pyco2.hello()
        ```
        
        As per the instructions in the [the CO2SYS-MATLAB repo](https://github.com/jamesorr/CO2SYS-MATLAB), you should also cite the original work by [Lewis and Wallace (1998)](https://pyco2sys.readthedocs.io/en/latest/refs/#l).
        
        ## Installation
        
        If you manage Python with conda, we recommend that you first install NumPy, pandas and xarray into the environment where PyCO2SYS is to be installed with conda.
        
        Then, you can install from the Python Package Index:
        
            pip install PyCO2SYS
        
        Update an existing installation:
        
            pip install PyCO2SYS --upgrade --no-cache-dir
        
        ## Basic use
        
        The only function you need is `pyco2.sys`.  To solve the marine carbonate system from two of its parameters (`par1` and `par2`), just use:
        
        ```python
        import PyCO2SYS as pyco2
        results = pyco2.sys(par1, par2, par1_type, par2_type, **kwargs)
        ```
        
        The keys to the `results` dict are described in the [online documentation](https://pyco2sys.readthedocs.io/en/latest/co2sys_nd/#results).  Arguments should be provided as scalars or NumPy arrays in any mutually broadcastable combination.  A large number of optional `kwargs` can be provided to specify everything beyond the carbonate system parameters â€” [read the docs!](https://pyco2sys.readthedocs.io/en/latest/co2sys_nd/).
        
        You can also look at the [examples Notebooks](https://github.com/mvdh7/PyCO2SYS-examples) that you can try out without needing to install anything on your computer.
        
        ## About
        
        PyCO2SYS is maintained by [Dr Matthew Humphreys](https://mvdh.xyz/) at the [NIOZ (Royal Netherlands Institute for Sea Research)](https://www.nioz.nl/en) with the support of the main developers of all previous versions of CO<sub>2</sub>SYS.
        
        Contributions are welcome; please check the [guidelines](https://github.com/mvdh7/PyCO2SYS/blob/master/CONTRIBUTING.md) before setting to work.
        
        ## License
        
        PyCO2SYS is licensed under the [GNU General Public License version 3 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0.en.html).
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Chemistry
Description-Content-Type: text/markdown
