Metadata-Version: 2.1
Name: miranda
Version: 0.5.0
Summary: Python utilities for climate data collection, conversion, and management
Keywords: xarray,climate,meteorology,hydrology,archiving,collection,conversion
Author-email: Trevor James Smith <smith.trevorj@ouranos.ca>
Maintainer-email: Travis Logan <logan.travis@ouranos.ca>, Pascal Bourgault <bourgault.pascal@ouranos.ca>
Requires-Python: >=3.7.0
Description-Content-Type: text/x-rst
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Dist: cftime
Requires-Dist: dask
Requires-Dist: distributed
Requires-Dist: h5netcdf
Requires-Dist: netCDF4
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pyessv
Requires-Dist: pyyaml
Requires-Dist: schema
Requires-Dist: xarray
Requires-Dist: xclim
Requires-Dist: zarr
Requires-Dist: black>=23.3.0 ; extra == "dev"
Requires-Dist: bump2version ; extra == "dev"
Requires-Dist: coverage[toml] ; extra == "dev"
Requires-Dist: flake8 ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: tox ; extra == "dev"
Requires-Dist: furo ; extra == "docs"
Requires-Dist: ipykernel ; extra == "docs"
Requires-Dist: nbsphinx ; extra == "docs"
Requires-Dist: pandoc ; extra == "docs"
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: sphinx_codeautolink ; extra == "docs"
Requires-Dist: sphinx_copybutton ; extra == "docs"
Requires-Dist: clisops ; extra == "gis"
Requires-Dist: geopandas ; extra == "gis"
Requires-Dist: regionmask ; extra == "gis"
Requires-Dist: xesmf ; extra == "gis"
Requires-Dist: cdsapi ; extra == "remote"
Requires-Dist: ecmwf-api-client ; extra == "remote"
Requires-Dist: fabric ; extra == "remote"
Requires-Dist: intake ; extra == "remote"
Requires-Dist: intake-esm ; extra == "remote"
Requires-Dist: numcodecs ; extra == "remote"
Requires-Dist: paramiko>=2.6.0 ; extra == "remote"
Requires-Dist: s3fs ; extra == "remote"
Requires-Dist: scp ; extra == "remote"
Project-URL: About Ouranos, https://www.ouranos.ca/en/
Project-URL: Changelog, https://miranda.readthedocs.io/en/stable/history.html
Project-URL: Homepage, https://miranda.readthedocs.io/
Project-URL: Issue tracker, https://github.com/Ouranosinc/miranda/issues
Project-URL: Source, https://github.com/Ouranosinc/miranda/
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: gis
Provides-Extra: remote

==============
Miranda |logo|
==============

|build| |coveralls| |black|

Python utilities for climate data collection, conversion, and management

* Documentation: |docs|
* Free Software: |license|

Features
--------

Data collection functions for climate and forecast data hosted at:
    * ECMWF (ERA5, ERA5-Land, TIGGE)
    * ECCC (Canada) (Monthly Climate Summaries, ECCC GEOAPI - In development)
    * NCAR (CORDEX-NA on AWS)

Data conversion for `Climate and Forecasting (CF) <https://cfconventions.org/>`_ Variable and Metadata compliance:
    * ECMWF (ERA5, ERA5-Land, TIGGE - In Development)
    * ECCC (Canada) (Flat File Observations, Monthly Climate Summaries, Adjusted and Homogenized Climate Data, ECCC GEOAPI - In Development)
    * MELCC (Québec)
    * Hydro-Québec (In Development)

Database structuring and facets validation:
    * Simulations:
       * WCRP (CMIP5, CMIP6, CMIP5-CORDEX, CORDEX-ADJUST, ISIMIP, etc.)
    * Station-Observations:
       * MELCC (Québec) (Needs `mdbtools <https://github.com/mdbtools/mdbtools>`_ installed)
       * ECCC (Canada) (In Development)
       * Hydro-Québec (In Development)
    * Gridded-Observations:
       * NRCAN (Canada) (Future)
       * MELCC (Future)
    * Reanalyses:
       * ECMWF (ERA5, ERA5-Land, TIGGE)
       * NASA (DayMET, AgMerra/AgCFSR, MERRA2) - In Development
       * NCEP (CFSR/CFSv2) - In Development
       * WFDEI-GEM-CaPa (University of Saskatchewan) - In Development

Installation
------------
`miranda` can be installed from PyPI::

    $ pip install miranda

Some functionalities require complex-to-install dependencies.
In order to gain access to them, we strongly suggest using `Anaconda <https://www.anaconda.com/products/distribution>`_ to manage your environment::

    $ conda env create -f environment.yml
    $ conda activate miranda
    $ pip install miranda[full]

For more information about Anaconda/Miniconda/conda-forge:
 * Miniconda: https://docs.conda.io/en/latest/miniconda.html
 * conda-forge: https://conda-forge.org/#about

`miranda` also relies on `PyESSV <https://github.com/ES-DOC/pyessv>`_ for its climate data controlled vocabulary.
This library is optional for users who do not require validation checks,
but enabling this feature requires additional installation steps::


    $ mkdir -p ~/.esdoc
    $ git clone git@github.com:ES-DOC/pyessv-archive.git ~/.esdoc/pyessv-archive

Contributing
------------
See the contributing documentation: https://miranda.readthedocs.io/en/latest/contributing.html

.. |build| image:: https://github.com/Ouranosinc/miranda/actions/workflows/main.yml/badge.svg
        :target: https://github.com/Ouranosinc/miranda/actions/workflows/main.yml
        :alt: Build Status

.. |coveralls| image:: https://coveralls.io/repos/github/Ouranosinc/miranda/badge.svg
        :target: https://coveralls.io/github/Ouranosinc/miranda
        :alt: Coveralls

.. |docs| image:: https://readthedocs.org/projects/miranda/badge
        :target: https://miranda.readthedocs.io/en/latest
        :alt: Documentation Status

.. |license| image:: https://img.shields.io/github/license/Ouranosinc/miranda.svg
        :target: https://github.com/Ouranosinc/miranda/blob/master/LICENSE
        :alt: License

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
        :target: https://github.com/psf/black
        :alt: Python Black

.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/miranda/main/docs/_static/images/miranda-logo-small.png
        :target: https://github.com/Ouranosinc/miranda
        :alt: Miranda

