==============
Miranda |logo|
==============
|build| |coveralls| |black|
Python utilities for climate data collection, conversion, and management
* Documentation: |docs|
* 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) <https://cfconventions.org/>`_ 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 <https://github.com/mdbtools/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 <https://www.anaconda.com/products/distribution>`_ 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 <https://github.com/ES-DOC/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
.. |build| image:: https://github.com/Ouranosinc/miranda/actions/workflows/main.yml/badge.svg
:target: https://github.com/Ouranosinc/miranda/actions/workflows/main.yml
: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
:target: https://miranda.readthedocs.io/en/latest
:alt: Documentation Status
.. |license| image:: https://img.shields.io/github/license/Ouranosinc/miranda.svg
:target: https://github.com/Ouranosinc/miranda/blob/master/LICENSE
:alt: License
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Python Black
.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/miranda/main/docs/_static/images/miranda-logo-small.png
:target: https://github.com/Ouranosinc/miranda
:alt: Miranda
Raw data
{
"_id": null,
"home_page": "",
"name": "miranda",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": "Travis Logan <logan.travis@ouranos.ca>, Pascal Bourgault <bourgault.pascal@ouranos.ca>",
"keywords": "xarray,climate,meteorology,hydrology,archiving,collection,conversion",
"author": "",
"author_email": "Trevor James Smith <smith.trevorj@ouranos.ca>",
"download_url": "https://files.pythonhosted.org/packages/3e/9b/bd03ed3b408e0b16d265382bf62cd7d6bc303e34a0154c1db3140938daf4/miranda-0.5.0.tar.gz",
"platform": null,
"description": "==============\nMiranda |logo|\n==============\n\n|build| |coveralls| |black|\n\nPython utilities for climate data collection, conversion, and management\n\n* Documentation: |docs|\n* Free Software: |license|\n\nFeatures\n--------\n\nData collection functions for climate and forecast data hosted at:\n * ECMWF (ERA5, ERA5-Land, TIGGE)\n * ECCC (Canada) (Monthly Climate Summaries, ECCC GEOAPI - In development)\n * NCAR (CORDEX-NA on AWS)\n\nData conversion for `Climate and Forecasting (CF) <https://cfconventions.org/>`_ Variable and Metadata compliance:\n * ECMWF (ERA5, ERA5-Land, TIGGE - In Development)\n * ECCC (Canada) (Flat File Observations, Monthly Climate Summaries, Adjusted and Homogenized Climate Data, ECCC GEOAPI - In Development)\n * MELCC (Qu\u00e9bec)\n * Hydro-Qu\u00e9bec (In Development)\n\nDatabase structuring and facets validation:\n * Simulations:\n * WCRP (CMIP5, CMIP6, CMIP5-CORDEX, CORDEX-ADJUST, ISIMIP, etc.)\n * Station-Observations:\n * MELCC (Qu\u00e9bec) (Needs `mdbtools <https://github.com/mdbtools/mdbtools>`_ installed)\n * ECCC (Canada) (In Development)\n * Hydro-Qu\u00e9bec (In Development)\n * Gridded-Observations:\n * NRCAN (Canada) (Future)\n * MELCC (Future)\n * Reanalyses:\n * ECMWF (ERA5, ERA5-Land, TIGGE)\n * NASA (DayMET, AgMerra/AgCFSR, MERRA2) - In Development\n * NCEP (CFSR/CFSv2) - In Development\n * WFDEI-GEM-CaPa (University of Saskatchewan) - In Development\n\nInstallation\n------------\n`miranda` can be installed from PyPI::\n\n $ pip install miranda\n\nSome functionalities require complex-to-install dependencies.\nIn order to gain access to them, we strongly suggest using `Anaconda <https://www.anaconda.com/products/distribution>`_ to manage your environment::\n\n $ conda env create -f environment.yml\n $ conda activate miranda\n $ pip install miranda[full]\n\nFor more information about Anaconda/Miniconda/conda-forge:\n * Miniconda: https://docs.conda.io/en/latest/miniconda.html\n * conda-forge: https://conda-forge.org/#about\n\n`miranda` also relies on `PyESSV <https://github.com/ES-DOC/pyessv>`_ for its climate data controlled vocabulary.\nThis library is optional for users who do not require validation checks,\nbut enabling this feature requires additional installation steps::\n\n\n $ mkdir -p ~/.esdoc\n $ git clone git@github.com:ES-DOC/pyessv-archive.git ~/.esdoc/pyessv-archive\n\nContributing\n------------\nSee the contributing documentation: https://miranda.readthedocs.io/en/latest/contributing.html\n\n.. |build| image:: https://github.com/Ouranosinc/miranda/actions/workflows/main.yml/badge.svg\n :target: https://github.com/Ouranosinc/miranda/actions/workflows/main.yml\n :alt: Build Status\n\n.. |coveralls| image:: https://coveralls.io/repos/github/Ouranosinc/miranda/badge.svg\n :target: https://coveralls.io/github/Ouranosinc/miranda\n :alt: Coveralls\n\n.. |docs| image:: https://readthedocs.org/projects/miranda/badge\n :target: https://miranda.readthedocs.io/en/latest\n :alt: Documentation Status\n\n.. |license| image:: https://img.shields.io/github/license/Ouranosinc/miranda.svg\n :target: https://github.com/Ouranosinc/miranda/blob/master/LICENSE\n :alt: License\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Python Black\n\n.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/miranda/main/docs/_static/images/miranda-logo-small.png\n :target: https://github.com/Ouranosinc/miranda\n :alt: Miranda\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python utilities for climate data collection, conversion, and management",
"version": "0.5.0",
"project_urls": {
"About Ouranos": "https://www.ouranos.ca/en/",
"Changelog": "https://miranda.readthedocs.io/en/stable/history.html",
"Homepage": "https://miranda.readthedocs.io/",
"Issue tracker": "https://github.com/Ouranosinc/miranda/issues",
"Source": "https://github.com/Ouranosinc/miranda/"
},
"split_keywords": [
"xarray",
"climate",
"meteorology",
"hydrology",
"archiving",
"collection",
"conversion"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "54b9d2f54a06229de4ef7de9689c8fe7c5c479e848081003f874dab28a77d80b",
"md5": "7f60223f63e9f3ebfe3a6e8716424c68",
"sha256": "a90ae19a241122f46f7cd174d65f4421103bd25b27c7466ae4f87fa6c2cab3fe"
},
"downloads": -1,
"filename": "miranda-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f60223f63e9f3ebfe3a6e8716424c68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0",
"size": 177895,
"upload_time": "2023-06-19T15:19:47",
"upload_time_iso_8601": "2023-06-19T15:19:47.179755Z",
"url": "https://files.pythonhosted.org/packages/54/b9/d2f54a06229de4ef7de9689c8fe7c5c479e848081003f874dab28a77d80b/miranda-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e9bbd03ed3b408e0b16d265382bf62cd7d6bc303e34a0154c1db3140938daf4",
"md5": "0d62f9538c5f37cbd521740eeca792bb",
"sha256": "de6f7de34fa54b473f72cff6ba6046f173a7799fdd875be69c901225ad682dea"
},
"downloads": -1,
"filename": "miranda-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "0d62f9538c5f37cbd521740eeca792bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 1223544,
"upload_time": "2023-06-19T15:19:48",
"upload_time_iso_8601": "2023-06-19T15:19:48.881922Z",
"url": "https://files.pythonhosted.org/packages/3e/9b/bd03ed3b408e0b16d265382bf62cd7d6bc303e34a0154c1db3140938daf4/miranda-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 15:19:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ouranosinc",
"github_project": "miranda",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "miranda"
}