Metadata-Version: 2.1
Name: netcdf-scm
Version: 2.0.2
Summary: Processing netCDF files for use with simple climate models
Home-page: https://github.com/znicholls/netcdf-scm
Author: Zebedee Nicholls
Author-email: zebedee.nicholls@climate-energy-college.org
License: 3-Clause BSD License
Project-URL: Bug Reports, https://github.com/znicholls/netcdf-scm/issues
Project-URL: Documentation, https://openscm.readthedocs.io/en/latest
Project-URL: Source, https://github.com/znicholls/netcdf-scm
Keywords: netcdf,netCDF,python,climate,atmosphere,simple climate model,reduced complexity climate model,data processing
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
Requires-Dist: cftime (<1.4)
Requires-Dist: click
Requires-Dist: numpy
Requires-Dist: python-dateutil
Requires-Dist: pymagicc (>=2.0.0rc5)
Requires-Dist: scmdata (>=0.7)
Requires-Dist: scipy
Requires-Dist: tqdm
Provides-Extra: ar6regions
Requires-Dist: regionmask (>=0.6) ; extra == 'ar6regions'
Provides-Extra: deploy
Requires-Dist: twine (>=1.11.0) ; extra == 'deploy'
Requires-Dist: setuptools (>=38.6.0) ; extra == 'deploy'
Requires-Dist: wheel (>=0.31.0) ; extra == 'deploy'
Provides-Extra: dev
Requires-Dist: bandit ; extra == 'dev'
Requires-Dist: beautifulsoup4 ; extra == 'dev'
Requires-Dist: black (==19.10b0) ; extra == 'dev'
Requires-Dist: black-nb ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: nbdime ; extra == 'dev'
Requires-Dist: pydocstyle ; extra == 'dev'
Requires-Dist: pylint (>=2.4.0) ; extra == 'dev'
Requires-Dist: regionmask (>=0.6) ; extra == 'dev'
Requires-Dist: twine (>=1.11.0) ; extra == 'dev'
Requires-Dist: setuptools (>=38.6.0) ; extra == 'dev'
Requires-Dist: wheel (>=0.31.0) ; extra == 'dev'
Requires-Dist: nbsphinx ; extra == 'dev'
Requires-Dist: sphinx (<2.1,>=1.4) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: sphinx-click ; extra == 'dev'
Requires-Dist: sphinx-copybutton ; extra == 'dev'
Requires-Dist: ipywidgets ; extra == 'dev'
Requires-Dist: notebook ; extra == 'dev'
Requires-Dist: expectexception ; extra == 'dev'
Requires-Dist: seaborn ; extra == 'dev'
Requires-Dist: codecov ; extra == 'dev'
Requires-Dist: nbval ; extra == 'dev'
Requires-Dist: pytest (<5.0,>=4.0) ; extra == 'dev'
Requires-Dist: pytest-benchmark ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-console-scripts ; extra == 'dev'
Requires-Dist: pytest-xdist ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: sphinx (<2.1,>=1.4) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinx-click ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Provides-Extra: notebooks
Requires-Dist: ipywidgets ; extra == 'notebooks'
Requires-Dist: notebook ; extra == 'notebooks'
Requires-Dist: expectexception ; extra == 'notebooks'
Requires-Dist: seaborn ; extra == 'notebooks'
Provides-Extra: tests
Requires-Dist: codecov ; extra == 'tests'
Requires-Dist: nbval ; extra == 'tests'
Requires-Dist: pytest (<5.0,>=4.0) ; extra == 'tests'
Requires-Dist: pytest-benchmark ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest-console-scripts ; extra == 'tests'
Requires-Dist: pytest-xdist ; extra == 'tests'

.. image:: https://gitlab.com/netcdf-scm/netcdf-scm/raw/master/docs/source/_static/logo.png
   :height: 50px
   :width: 100px
   :alt: Logo


netCDF-SCM
==========

+--------+-------------------+-------------+-----------+--------+-----------------+
| Basics | |Python Versions| | |Platforms| | |License| | |Docs| | |Conda install| |
+--------+-------------------+-------------+-----------+--------+-----------------+

+-----------+-------------+----------+
| Citations | |GDJ paper| | |Zenodo| |
+-----------+-------------+----------+

+-------------------+----------------+-----------+
| Repository health | |Build Status| | |Codecov| |
+-------------------+----------------+-----------+

+-----------------+------------+--------+
| Latest releases | |Anaconda| | |PyPI| |
+-----------------+------------+--------+

.. sec-begin-index

netCDF-SCM is a Python package for processing netCDF files.
It focusses on metrics which are relevant to simple climate models and is built on top of the Iris_ package.

.. _Iris: https://github.com/SciTools/iris

.. sec-end-index

License
-------

.. sec-begin-license

netCDF-SCM is free software under a BSD 3-Clause License, see `LICENSE <https://github.com/znicholls/netcdf-scm/blob/master/LICENSE>`_.
If you make any use of netCDF-SCM, please cite the `Geoscience Data Journal (GDJ) <https://doi.org/10.1002/gdj3.113>`_ paper (`Nicholls et al., GDJ 2021 <https://doi.org/10.1002/gdj3.113>`_) as well as the relevant `Zenodo release <https://zenodo.org/search?page=1&size=20&q=netcdf-scm>`_.

.. sec-end-license

.. sec-begin-installation

Installation
------------

The easiest way to install netCDF-SCM is with `conda <https://conda.io/miniconda.html>`_

::

    # if you're using a conda environment, make sure you're in it
    conda install -c conda-forge netcdf-scm

It is also possible to install it with `pip <https://pypi.org/project/pip/>`_

::

  # if you're using a virtual environment, make sure you're in it
  pip install netcdf-scm

However installing with pip requires installing all of Iris_'s dependencies yourself which is not trivial.
As far as we know, Iris_ cannot be installed with pip alone.

.. _Iris: https://github.com/SciTools/iris

.. sec-end-installation

Documentation
-------------

Documentation can be found at our `documentation pages <https://netcdf-scm.readthedocs.io/en/latest/>`_ (we are thankful to `Read the Docs <https://readthedocs.org/>`_ for hosting us).

Contributing
------------

Please see the `Development section of the docs <https://netcdf-scm.readthedocs.io/en/latest/development.html>`_.

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/netcdf-scm.svg
    :target: https://pypi.org/project/netcdf-scm/
.. |Platforms| image:: https://anaconda.org/conda-forge/netcdf-scm/badges/platforms.svg
    :target: https://anaconda.org/conda-forge/netcdf-scm
.. |License| image:: https://img.shields.io/badge/license-BSD_3-blue
    :target: https://gitlab.com/netcdf-scm/netcdf-scm/blob/master/LICENSE
.. |Docs| image:: https://readthedocs.org/projects/netcdf-scm/badge/?version=latest
    :target: https://netcdf-scm.readthedocs.io/en/latest/
.. |Conda install| image:: https://anaconda.org/conda-forge/netcdf-scm/badges/installer/conda.svg
    :target: https://conda.anaconda.org/conda-forge
.. |GDJ Paper| image:: https://img.shields.io/badge/GDJ-Nicholls%20et%20al.%20(2021)-lightgrey
    :target: https://doi.org/10.1002/gdj3.113
.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3902224.svg
    :target: https://doi.org/10.5281/zenodo.3902224
.. |Build Status| image:: https://gitlab.com/netcdf-scm/netcdf-scm/badges/master/pipeline.svg
    :target: https://gitlab.com/netcdf-scm/netcdf-scm
.. |Codecov| image:: https://gitlab.com/netcdf-scm/netcdf-scm/badges/master/coverage.svg
    :target: https://gitlab.com/netcdf-scm/netcdf-scm/commits/master
.. |Anaconda| image:: https://anaconda.org/conda-forge/netcdf-scm/badges/version.svg
    :target: https://anaconda.org/conda-forge/netcdf-scm
.. |PyPI| image:: https://img.shields.io/pypi/v/netcdf-scm.svg
    :target: https://pypi.org/project/netcdf-scm/

.. [Morin et al. 2012]: https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1002598


