Miranda

A modern Python utility library for climate data collection and management.
https://github.com/Ouranosinc/miranda

Category: Climate Change
Sub Category: Climate Data Processing and Analysis

Keywords

archiving climate collection management netcdf

Keywords from Contributors

anuclim climate-analysis climate-science icclim netcdf4 xclim earth-system-model indices measur raven

Last synced: about 18 hours ago
JSON representation

Repository metadata

A modern Python utility library for climate data collection and management

• Host: GitHub
• URL: https://github.com/Ouranosinc/miranda
• Owner: Ouranosinc
• License: apache-2.0
• Created: 2019-08-22T16:12:39.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-17T19:14:19.000Z (9 days ago)
• Last Synced: 2025-04-22T07:25:39.115Z (5 days ago)
• Topics: archiving, climate, collection, management, netcdf
• Language: Python
• Size: 51 MB
• Stars: 19
• Watchers: 5
• Forks: 2
• Open Issues: 18
• Releases: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Authors: AUTHORS.rst
  • Zenodo: .zenodo.json

README.rst

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

+----------------------------+-----------------------------------------------------+
| Versions                   | |pypi| |versions|                                   |
+----------------------------+-----------------------------------------------------+
| Documentation and Support  | |docs|                                              |
+----------------------------+-----------------------------------------------------+
| Open Source                | |license| |ossf|                                    |
+----------------------------+-----------------------------------------------------+
| Coding Standards           | |black| |ruff| |pre-commit|                         |
+----------------------------+-----------------------------------------------------+
| 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 (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) `_ 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 `_ 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 `_ 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 `_ 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 [email protected]:ES-DOC/pyessv-archive.git ~/.esdoc/pyessv-archive

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

Credits
-------

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

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _`Ouranosinc/cookiecutter-pypackage`: https://github.com/Ouranosinc/cookiecutter-pypackage


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

.. |build| image:: https://github.com/Ouranosinc/miranda/actions/workflows/main.yml/badge.svg
        :target: https://github.com/Ouranosinc/miranda/actions
        :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/?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| 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| 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

.. |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

        

---

Owner metadata

• Name: Ouranos inc.
• Login: Ouranosinc
• Email:
• Kind: organization
• Description: Consortium on regional climatology
• Website: www.ouranos.ca
• Location: Canada
• Twitter: ouranos_cc
• Company:
• Icon url: https://avatars.githubusercontent.com/u/1696763?v=4
• Repositories: 37
• Last ynced at: 2023-02-26T14:20:41.025Z
• Profile URL: https://github.com/Ouranosinc

---

GitHub Events

Total

• Issues event: 2
• Watch event: 2
• Delete event: 32
• Issue comment event: 37
• Push event: 145
• Pull request review comment event: 18
• Pull request event: 65
• Pull request review event: 46
• Create event: 32

Last Year

• Issues event: 2
• Watch event: 2
• Delete event: 32
• Issue comment event: 37
• Push event: 145
• Pull request review comment event: 18
• Pull request event: 65
• Pull request review event: 46
• Create event: 32

---

Committers metadata

Last synced: 5 days ago

Name	Email	Commits
Zeitsperre	1****e	910
tlogan2000	l****s@o****a	117
pre-commit-ci[bot]	6****]	112
dependabot[bot]	4****]	43
bumpversion[bot]	b****]@o****a	36
juliettelavoie	j****e@h****a	27
Pascal Bourgault	b****l@o****a	25
Asli Bese	a****e@d****a	20
RondeauG	r****l@o****a	3
Asli Bese	1****e	2
David Huard	h****d@o****a	2

Committer domains:

• ouranos.ca: 5
• doris.ouranos.ca: 1
• hotmail.ca: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/Ouranosinc/miranda

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 155 last-month
• Total dependent packages: 0
• Total dependent repositories: 0
• Total versions: 3
• Total maintainers: 2

---

Dependencies

Score: 11.065058990790902