Miranda#

Build Status Coveralls CodeFactor 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) (In Development)

  • Hydro-Québec (In Development)

Database structuring and facets validation:
  • Simulations:
    • WCRP (CORDEX, CORDEX-ADJUST, CMIP5, CMIP6, ISIMIP, etc.)

  • Station-Observations:
    • ECCC (Canada) (In Development)

    • MELCC (Québec) (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 is not yet available on PyPI, so the suggested method to install is as follows:

$ git clone git@github.com:Ouranosinc/miranda.git
$ cd miranda

# If using Anaconda:
$ conda create -n miranda -f environment.yml
$ conda activate miranda

$ pip install miranda[full]

miranda also relies on PyESSV for its climate data controlled vocabulary. This library requires additional installation steps:

$ mkdir -p ~/.esdoc
$ git clone git@github.com:ES-DOC/pyessv-archive.git ~/.esdoc/pyessv-archive
We strongly suggest using Anaconda3/miniconda3 (with the conda-forge repository enabled) to manage your environment and dependencies

Contributing#

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

Contents:#

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.