Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Miranda 0.7.1 documentation
Logo
Miranda 0.7.1 documentation

Contents

  • Miranda
  • Installation
  • Usage
  • Contributing
  • Releasing
  • Credits
  • Changelog
  • Security Policy
  • License

All Modules

  • miranda
    • miranda package
      • miranda.convert package
      • miranda.decode package
      • miranda.eccc package
      • miranda.ecmwf package
      • miranda.ghcn package
      • miranda.gis package
      • miranda.io package
      • miranda.ncar package
      • miranda.preprocess package
      • miranda.structure package
      • miranda.testing package
      • miranda.treatments package
      • miranda.validate package
      • miranda.vocabularies package

GitHub Repository

  • Ouranosinc/miranda
Back to top
View this page
Edit this page

Miranda Miranda¶

Versions

PyPI Conda-forge Build Version

Documentation and Support

Documentation Status Supported Python Versions

Open Source

License OpenSSF Scorecard DOI

Coding Standards

Ruff prek pre-commit.ci status Open Source Security Foundation Best Practices

Development Status

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Build Status 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) 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 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:

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

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.

https://raw.githubusercontent.com/Ouranosinc/.github/refs/heads/main/images/logo-ouranos-horizontal-couleur.svg

This package was created with Cookiecutter and the Ouranosinc/cookiecutter-pypackage project template.

Next
Installation
Previous
Home
Copyright © 2019-2026, Trevor James Smith, Ouranos Inc.
Made with Sphinx and @pradyunsg's Furo
On this page
  • Miranda
    • Features
    • Installation
    • Contributing
    • Acknowledgments