Metadata-Version: 2.4
Name: miranda
Version: 0.7.1
Summary: Python utilities for climate data collection, conversion, and management.
Keywords: xarray,climate,meteorology,hydrology,archiving,collection,conversion,miranda
Author-email: Trevor James Smith <smith.trevorj@ouranos.ca>
Maintainer-email: Trevor James Smith <smith.trevorj@ouranos.ca>, Travis Logan <logan.travis@ouranos.ca>, Pascal Bourgault <bourgault.pascal@ouranos.ca>
Requires-Python: >=3.10.0
Description-Content-Type: text/x-rst
License-Expression: Apache-2.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Typing :: Typed
License-File: LICENSE
Requires-Dist: cftime >=1.4.1
Requires-Dist: cf-xarray >=0.10.4
Requires-Dist: dask >=2024.8.1
Requires-Dist: filelock >=3.14.0
Requires-Dist: h5netcdf >=1.5.0
Requires-Dist: h5py >=3.12.1
Requires-Dist: numcodecs <0.16
Requires-Dist: numpy >=1.25
Requires-Dist: packaging >=24.0
Requires-Dist: pandas >=1.0.0
Requires-Dist: pyessv
Requires-Dist: pyyaml >=6.0.1
Requires-Dist: schema >=0.7.7
Requires-Dist: xarray >=2023.11.0
Requires-Dist: xclim >=0.57.0
Requires-Dist: zarr
Requires-Dist: miranda[gis] ; extra == "all"
Requires-Dist: miranda[remote] ; extra == "all"
Requires-Dist: clisops >=0.16.1 ; extra == "gis"
Requires-Dist: geopandas >=1.0.0 ; extra == "gis"
Requires-Dist: regionmask >=0.13.0 ; extra == "gis"
Requires-Dist: shapely >=2.0 ; extra == "gis"
Requires-Dist: xesmf ; extra == "gis"
Requires-Dist: cdsapi ; extra == "remote"
Requires-Dist: ecmwf-api-client ; extra == "remote"
Requires-Dist: intake ; extra == "remote"
Requires-Dist: intake-esm ; extra == "remote"
Requires-Dist: requests >=2.33.0 ; extra == "remote"
Requires-Dist: s3fs ; extra == "remote"
Project-URL: About Ouranos, https://ouranos.ca/en/
Project-URL: Changelog, https://miranda.readthedocs.io/en/stable/changelog.html
Project-URL: Citation, https://doi.org/10.5281/zenodo.17048365
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: all
Provides-Extra: gis
Provides-Extra: remote

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

+----------------------------+-----------------------------------------------------+
| Versions                   | |pypi| |conda|                                      |
+----------------------------+-----------------------------------------------------+
| Documentation and Support  | |docs| |versions|                                   |
+----------------------------+-----------------------------------------------------+
| Open Source                | |license| |ossf-score| |zenodo|                     |
+----------------------------+-----------------------------------------------------+
| Coding Standards           | |ruff| |prek| |pre-commit-ci| |ossf-bp|             |
+----------------------------+-----------------------------------------------------+
| Development Status         | |status| |build| |coveralls|                        |
+----------------------------+-----------------------------------------------------+

Python utilities for climate data collection, conversion, and management.

* Free software: Apache Software License 2.0
* Documentation: https://miranda.readthedocs.io.

Features
--------

Data collection functions for climate and forecast data hosted at:
    * ECMWF (Europe) (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 (Europe) (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) (In Development)
       * MELCC (Québec) (In Development)
    * Reanalyses:
       * ECCC (Canada) (CanSWE, CaSR, RDRS)
       * ECMWF (Europe) (ERA5, ERA5-Land, TIGGE)
       * NASA (DayMET, NEX-GDDP) (In Development)
       * USask (Canada) (EMDNA)

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

`miranda` can be installed from PyPI:

.. code-block:: shell

    $ python -m 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:

.. code-block:: shell

    $ conda env create -f environment.yml
    $ conda activate miranda
    $ python -m 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:

.. code-block:: shell

    $ 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

Acknowledgments
---------------

`miranda` development is funded through `Ouranos`_, a not-for-profit collaborative innovation organization fostering resilient adaptation to climate change, based in Québec, Canada.

.. image:: https://raw.githubusercontent.com/Ouranosinc/.github/refs/heads/main/images/logo-ouranos-horizontal-couleur.svg
        :target: https://www.ouranos.ca/en
        :align: center
        :class: ouranos-logo no-theme center

|ouranos-dark| |ouranos-light|

This package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _Ouranos: https://www.ouranos.ca/en
.. _Ouranosinc/cookiecutter-pypackage: https://github.com/Ouranosinc/cookiecutter-pypackage

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

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/python-miranda.svg
        :target: https://anaconda.org/conda-forge/python-miranda
        :alt: Conda-forge Build Version

.. |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/?version=latest
        :target: https://miranda.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status

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

.. |ossf-bp| image:: https://bestpractices.coreinfrastructure.org/projects/11291/badge
        :target: https://bestpractices.coreinfrastructure.org/projects/11291
        :alt: Open Source Security Foundation Best Practices

.. |ossf-score| image:: https://api.securityscorecards.dev/projects/github.com/Ouranosinc/miranda/badge
        :target: https://securityscorecards.dev/viewer/?uri=github.com/Ouranosinc/miranda
        :alt: OpenSSF Scorecard

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

.. |pre-commit-ci| image:: https://results.pre-commit.ci/badge/github/Ouranosinc/miranda/main.svg
        :target: https://results.pre-commit.ci/latest/github/Ouranosinc/miranda/main
        :alt: pre-commit.ci status

.. |prek| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json
        :target: https://github.com/j178/prek
        :alt: prek

.. |pypi| image:: https://img.shields.io/pypi/v/miranda.svg
        :target: https://pypi.python.org/pypi/miranda
        :alt: PyPI

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
        :target: https://github.com/astral-sh/ruff
        :alt: Ruff

.. |status| image:: https://www.repostatus.org/badges/latest/active.svg
        :target: https://www.repostatus.org/#active
        :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.

.. |versions| image:: https://img.shields.io/pypi/pyversions/miranda.svg
        :target: https://pypi.python.org/pypi/miranda
        :alt: Supported Python Versions

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.17048366.svg
        :target: https://doi.org/10.5281/zenodo.17048366
        :alt: DOI

.. Ouranos Logos

.. |ouranos-light| image:: https://raw.githubusercontent.com/Ouranosinc/miranda/main/docs/_static/images/empty.png
        :target: https://www.ouranos.ca/en
        :alt:
        :class: ouranos-logo only-light center

.. |ouranos-dark| image:: https://raw.githubusercontent.com/Ouranosinc/miranda/main/docs/_static/images/empty.png
        :target: https://www.ouranos.ca/en
        :alt:
        :class: ouranos-logo only-dark center

