Skip to main content

Package for accessing CMIP6 database in real-time

Project description

https://img.shields.io/travis/TaufiqHassan/acccmip6.svg https://img.shields.io/pypi/v/acccmip6.svg https://readthedocs.org/projects/acccmip6/badge https://zenodo.org/badge/208252347.svg

acccmip6 package can access CMIP6 database in real-time.

Features

  • Real-time search and download from continuously updating CMIP6 database

  • Find data for any specific items (e.g. model, experiment, variable, frequency, realm)

  • Search and download any combination of the above items

  • Find the total number of available files and realizations

  • Validate your search items

  • Get suggestions if necessary

  • Access definition of the experiments

  • Skips already existing files

Installation

Install is as simple as typing -

pip install acccmip6

Requires python v3.5 or up and pip. Mac users can use brew install python3 and python get-pip.py from terminal. Windows users can use Windows Subsystem.

Installation demo

docs/installation_demo.gif

You may also install the package via conda -

conda install -c thassan acccmip6

Usage

acccmip6 searches the live CMIP6 database and spits out currently available models, experiments and variables that satisfies your search criteria. It will also output the number of available files. acccmip6 also tries to be a good command-line interface (CLI). Run acccmip6 -h to see a help message with all the arguments you can pass.

Required Arguments

  • -o : Takes output type. ‘S’ for searching the database or ‘D’ for downloading from the database.

Optional Arguments

  • -m : Model names (multiple comma separated names are allowed)

  • -e : Experiment names

  • -f : CMIP6 output frequency (e.g. mon, day etc.)

  • -v : Variable names

  • -r : Realm name (e.g. atmos, ocean etc.)

  • -rlzn : Select a specified realization

  • -c : ‘yes’ to use checker when searching or downloading. This helps to find out whether the search items are currently available. If not, it will produce suggestions that matches closely to your search.

  • -desc : ‘yes’ to get the description of the experiments searched for

  • -dir : Download directory

  • -skip : Skip any item (model/experiment/realizations) from your download

  • -time : ‘yes’ to print out all available time periods

  • -yr : Select data for a time period (number of years)

Demo

Search CMIP6 database with acccmip6 -o S

docs/searching_demo.gif

Download CMIP6 data with acccmip6 -o D

docs/downloading_demo.gif

License

This code is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acccmip6-5.3.0.tar.gz (110.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

acccmip6-5.3.0-py2.py3-none-any.whl (102.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file acccmip6-5.3.0.tar.gz.

File metadata

  • Download URL: acccmip6-5.3.0.tar.gz
  • Upload date:
  • Size: 110.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.9

File hashes

Hashes for acccmip6-5.3.0.tar.gz
Algorithm Hash digest
SHA256 b72ca92eb0156ea77dfbbb9d9ddfaa88a25060f8977d3a287162d0662742693b
MD5 90bc975cf058f9308aba3f0ce1dd1158
BLAKE2b-256 192359010ec1b7018b661e8deafe0e340780a137b82762d4630b9c521f770311

See more details on using hashes here.

File details

Details for the file acccmip6-5.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: acccmip6-5.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 102.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.9

File hashes

Hashes for acccmip6-5.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0f2d006fa351827929598c2fd6d90a449f26735f95888a0346a739c59547523c
MD5 4eac0b5aae22c0d27e32dbf6ec0b0e61
BLAKE2b-256 c45093041a5f7203c76fb58b2792dece333e808f7e463432742a61e6d4204973

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page