Contents Menu Expand Light mode Dark mode Auto light/dark mode
Miranda 0.4.0 documentation
Logo
Miranda 0.4.0 documentation
  • Installation
  • Usage
  • Contributing
  • Credits
  • History
  • License

All Modules

  • miranda
    • miranda package
      • miranda.archive package
      • miranda.convert package
      • miranda.decode package
      • miranda.eccc package
      • miranda.ecmwf package
      • miranda.gis package
      • miranda.io package
      • miranda.ncar package
      • miranda.remote package
      • miranda.structure package
  v: stable
Versions
latest
stable
Downloads
pdf
html
On Read the Docs
Project Home
Builds
Back to top

Miranda Miranda#

Build Status Coveralls Python Black

Python utilities for climate data collection, conversion, and management

  • Documentation: Documentation Status

  • 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) 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 git@github.com:ES-DOC/pyessv-archive.git ~/.esdoc/pyessv-archive

Contributing#

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

Contents:#

  • Installation
    • From sources
    • Creating a Conda environment
  • Usage
  • Contributing
    • Types of Contributions
    • Get Started!
    • Pull Request Guidelines
    • Tips
  • Credits
    • Development Lead
    • Co-Developers
    • Contributors
  • History
    • v0.4.0 (2023-03-30)
    • v0.3.0 (2022-11-24)
  • License

All Modules

  • miranda
    • miranda package

Indices and tables#

  • Index

  • Module Index

  • Search Page

Feedback#

If you have any suggestions or questions about Miranda feel free to email me at smith.trevorj@ouranos.ca.

If you encounter any errors or problems with Miranda, please let me know! Open an Issue at the GitHub https://github.com/Ouranosinc/miranda main repository.

Next
Installation
Copyright © 2019-2023, Trevor James Smith and contributors
Made with Sphinx and @pradyunsg's Furo
On this page
  • Miranda
    • Features
    • Installation
    • Contributing
      • Contents:
      • Indices and tables
      • Feedback