Data

Tools

Indexes

Applications

Experiments

Open Source Science

acccmip6

Python package for accessing and downloading CMIP6 database

https://github.com/taufiqhassan/acccmip6

Science Score: 64.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    2 of 5 committers (40.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary

Keywords

cmip6 cmip6-data-download cmip6-realtime
Last synced: 6 months ago · JSON representation ·

Repository

Python package for accessing and downloading CMIP6 database

Basic Info
  • Host: GitHub
  • Owner: TaufiqHassan
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 16.3 MB
Statistics
  • Stars: 131
  • Watchers: 5
  • Forks: 27
  • Open Issues: 4
  • Releases: 3
Topics
cmip6 cmip6-data-download cmip6-realtime
Created over 6 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation Authors

README.rst 

===============================
Access Cmip6
===============================

.. image:: https://img.shields.io/travis/TaufiqHassan/acccmip6.svg
        :target: https://travis-ci.org/TaufiqHassan/acccmip6

.. image:: https://img.shields.io/pypi/v/acccmip6.svg
        :target: https://pypi.python.org/pypi/acccmip6

.. image:: https://readthedocs.org/projects/acccmip6/badge
        :target: https://acccmip6.readthedocs.org
        
.. image:: https://zenodo.org/badge/208252347.svg
   :target: https://zenodo.org/badge/latestdoi/208252347


``acccmip6`` package can access CMIP6 database in real-time.

* GitHub repo: https://github.com/TaufiqHassan/acccmip6
* Documentation: https://acccmip6.readthedocs.org.

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`_.

.. _`Windows Subsystem`: https://docs.microsoft.com/en-us/windows/wsl/install-win10

Installation demo

.. image:: docs/installation_demo.gif

You may also install the package via conda. Make sure you have added the conda-forge channel in your environment. You can add any channel by -

``conda config --env --add channels conda-forge``

Then install ``acccmip6`` from ``thassan`` channel:

``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)
- ``-n`` : Select specific data nodes (multiple node selection allowed)
- ``-serv`` : Set user-defined server
- ``-cr`` : Select common realizations among selected experiments

Demo
-----

Search CMIP6 database with ``acccmip6 -o S``

.. image:: docs/searching_demo.gif

Download CMIP6 data with ``acccmip6 -o D``

.. image:: docs/downloading_demo.gif

License
-------

This code is licensed under the `MIT License`_.

.. _`MIT License`: https://opensource.org/licenses/MIT

Owner

  • Name: Taufiq Hassan
  • Login: TaufiqHassan
  • Kind: user
  • Location: Richland, WA
  • Company: PNNL

Postdoc RA @PNNL

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If interested, cite it as below."
authors:
- family-names: "Hassan"
  given-names: "Taufiq"
  orcid: "0000-0003-2361-6361"
title: "acccmip6: Python package for accessing and downloading CMIP6 data"
version: 5.2.0
doi: 10.5281/zenodo.6559056
date-released: 2022-05-18
url: "https://github.com/TaufiqHassan/acccmip6"

GitHub Events

Total
  • Issues event: 5
  • Watch event: 9
  • Issue comment event: 1
  • Fork event: 1
Last Year
  • Issues event: 5
  • Watch event: 9
  • Issue comment event: 1
  • Fork event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 93
  • Total Committers: 5
  • Avg Commits per committer: 18.6
  • Development Distribution Score (DDS): 0.075
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
TaufiqHassan t****6@g****m 86
Bo Fu 4****o 4
Taufiq Hassan 4****n 1
TaufiqHassan m****4@u****u 1
TaufiqHassan t****n@p****v 1
Committer Domains (Top 20 + Academic)
pnnl.gov: 1 ucr.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 18
  • Total pull requests: 1
  • Average time to close issues: 23 days
  • Average time to close pull requests: 7 days
  • Total issue authors: 14
  • Total pull request authors: 1
  • Average comments per issue: 1.61
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 0
  • Average time to close issues: 2 days
  • Average time to close pull requests: N/A
  • Issue authors: 3
  • Pull request authors: 0
  • Average comments per issue: 0.67
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • longbiao1993 (2)
  • cyndyfem (2)
  • CGL5230 (2)
  • Saibo-Li (1)
  • XiangLiu-github (1)
  • lihansunbai (1)
  • Datseris (1)
  • rafaelcavalcantii (1)
  • at123456789x (1)
  • tomorrgod (1)
  • allatnot (1)
  • SHEN-Cheng (1)
  • caowy8 (1)
Pull Request Authors
  • pkufubo (1)
Top Labels
Issue Labels
server (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 316 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 24
  • Total maintainers: 1
pypi.org: acccmip6

Package for accessing CMIP6 database in real-time

  • Versions: 24
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 316 Last month
Rankings
Stargazers count: 7.5%
Forks count: 7.7%
Dependent packages count: 10.1%
Downloads: 10.3%
Average: 11.4%
Dependent repos count: 21.6%
Maintainers (1)
thassan
Last synced: 7 months ago

Dependencies

requirements.in pypi
  • pandas *
  • requests *
  • setuptools *
  • xlrd *