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

climate-analysis climate-science netcdf4 xclim icclim anuclim indices ogc wps raven

Last synced: 1 day ago
JSON representation

Repository metadata

A modern Python utility library for climate data collection and management

README.rst

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

+----------------------------+-----------------------------------------------------+
| Versions                   | |pypi|                                              |
+----------------------------+-----------------------------------------------------+
| Documentation and Support  | |docs| |versions|                                   |
+----------------------------+-----------------------------------------------------+
| Open Source                | |license| |ossf-score|                              |
+----------------------------+-----------------------------------------------------+
| Coding Standards           | |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 (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::

    $ 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

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

.. |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/miranda.svg
            :target: https://anaconda.org/conda-forge/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/9945/badge
            :target: https://bestpractices.coreinfrastructure.org/projects/9945
            :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| 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


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 1,519
Total Committers: 15
Avg Commits per committer: 101.267
Development Distribution Score (DDS): 0.411

Commits in past year: 331
Committers in past year: 8
Avg Commits per committer in past year: 41.375
Development Distribution Score (DDS) in past year: 0.707

Name Email Commits
Zeitsperre 1****e@u****m 895
tlogan2000 l****s@o****a 137
pre-commit-ci[bot] 6****]@u****m 132
Zeitsperre t****h@l****m 123
dependabot[bot] 4****]@u****m 64
Asli Bese a****e@d****a 43
bumpversion[bot] b****]@o****a 36
juliettelavoie j****e@h****a 27
Ouranos Helper Bot g****t@o****a 25
Pascal Bourgault b****l@o****a 17
Phobos p****t@g****m 8
Trevor James Smith s****j@o****a 4
RondeauG r****l@o****a 3
Asli Bese 1****e@u****m 3
David Huard h****d@o****a 2

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 37
Total pull requests: 320
Average time to close issues: 7 months
Average time to close pull requests: 16 days
Total issue authors: 8
Total pull request authors: 9
Average comments per issue: 2.38
Average comments per pull request: 0.53
Merged pull request: 258
Bot issues: 2
Bot pull requests: 193

Past year issues: 4
Past year pull requests: 129
Past year average time to close issues: about 1 hour
Past year average time to close pull requests: 14 days
Past year issue authors: 3
Past year pull request authors: 5
Past year average comments per issue: 0.75
Past year average comments per pull request: 0.62
Past year merged pull request: 81
Past year bot issues: 2
Past year bot pull requests: 93

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

Top Issue Authors

  • Zeitsperre (18)
  • juliettelavoie (8)
  • aulemahal (4)
  • DoMatte (2)
  • dependabot[bot] (2)
  • tlogan2000 (1)
  • aslibese (1)
  • RondeauG (1)

Top Pull Request Authors

  • dependabot[bot] (128)
  • Zeitsperre (87)
  • pre-commit-ci[bot] (65)
  • tlogan2000 (16)
  • aslibese (13)
  • aulemahal (4)
  • juliettelavoie (3)
  • RondeauG (2)
  • huard (2)

Top Issue Labels

  • enhancement (15)
  • invalid (3)
  • data bug (2)
  • wontfix (2)
  • bug (2)
  • documentation (2)
  • dependencies (2)
  • python (2)
  • help wanted (1)
  • priority (1)
  • CI (1)

Top Pull Request Labels

  • dependencies (128)
  • CI (86)
  • python (68)
  • github_actions (60)
  • enhancement (32)
  • documentation (14)
  • docs (14)
  • bug (9)
  • invalid (2)

Package metadata

proxy.golang.org: github.com/ouranosinc/miranda

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/ouranosinc/miranda#section-documentation
  • Licenses: apache-2.0
  • Latest release: v0.6.0 (published 29 days ago)
  • Last Synced: 2025-09-30T21:06:51.335Z (2 days ago)
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.395%
    • Average: 5.576%
    • Dependent repos count: 5.758%
proxy.golang.org: github.com/Ouranosinc/miranda

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/Ouranosinc/miranda#section-documentation
  • Licenses: apache-2.0
  • Latest release: v0.6.0 (published 29 days ago)
  • Last Synced: 2025-09-30T21:06:51.336Z (2 days ago)
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.395%
    • Average: 5.576%
    • Dependent repos count: 5.758%
pypi.org: miranda

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

  • Homepage: https://miranda.readthedocs.io/
  • Documentation: https://miranda.readthedocs.io/
  • Licenses: Apache Software License
  • Latest release: 0.6.0 (published 29 days ago)
  • Last Synced: 2025-09-30T21:06:51.357Z (2 days ago)
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 171 Last month
  • Rankings:
    • Dependent packages count: 6.633%
    • Stargazers count: 16.126%
    • Forks count: 19.553%
    • Average: 21.323%
    • Dependent repos count: 30.611%
    • Downloads: 33.691%
  • Maintainers (2)

Dependencies

.github/workflows/auto-bumpversion.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • ad-m/github-push-action master composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • deadsnakes/action v2.1.1 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/publish-pypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/tag-testpypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
  • cftime *
  • dask *
  • distributed *
  • h5netcdf *
  • netCDF4 *
  • numpy *
  • pandas *
  • pyessv *
  • pyyaml *
  • schema *
  • xarray *
  • xclim *
  • zarr *
requirements_remote.txt pypi
  • cdsapi *
  • distributed *
  • ecmwf-api-client *
  • fabric *
  • intake *
  • intake-esm *
  • numcodecs *
  • paramiko >=2.6.0
  • s3fs *
  • scp *
environment.yml conda
  • black >=23.3.0
  • bump2version
  • cdsapi
  • cftime
  • clisops >=0.9
  • coverage
  • dask
  • distributed
  • ecmwf-api-client
  • fabric
  • flake8
  • furo >=2023.07.26
  • h5netcdf
  • intake
  • intake-esm
  • ipython
  • nbsphinx
  • netcdf4
  • numba >=0.55.2
  • numcodecs
  • numpy
  • pandas
  • pandoc
  • paramiko >=2.6.0
  • pre-commit
  • pyproj
  • pytest
  • python >=3.7,<3.12
  • pyupgrade
  • pyyaml
  • regionmask
  • requests
  • s3fs
  • schema
  • scp
  • sphinx
  • sphinx-codeautolink
  • sphinx-copybutton
  • tox >=4.0
  • xarray
  • xclim >=0.33.0
  • xesmf
  • zarr

Score: 11.472259708244213