Giter Club home page Giter Club logo

nirddmc's Introduction

Data Management Catalogs for Data on NIRD

The nirddmc command line tool is used for creating an "intake-catalog" needed for using intake-esm. It allows for efficient and easy browsing and subsetting of the data archive available on NIRD.

Installation

Clone the repository:

git clone https://github.com/Ovewh/nirddmc.git && cd nirddmc

Install the cli:

pip install -e .

Usage

To use nirddmc, run the following command:

nirddmc --help
Usage: nirddmc [OPTIONS]                                                                                                                                                  
                                                                                                                                                                           
 Build a catalog of CMIP data assets                                                                                                                                       
                                                                                                                                                                           
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *  --root-paths           -rp                              TEXT     Root path of the CMIP project output. [default: None] [required]                                    │
│    --depth                                                 INTEGER  Recursion depth. Recursively walk root_path to a specified depth [default: 4]                       │
│    --pick-latest-version       --no-pick-latest-version             Whether to only catalog lastest version of data assets or keep all versions                         │
│                                                                     [default: pick-latest-version]                                                                      │
│    --cmip-version                                          INTEGER  CMIP phase (e.g. 5 for CMIP5 or 6 for CMIP6) [default: 6]                                           │
│    --csv-filepath                                          TEXT     File path to use when saving the built catalog [default: None]                                      │
│    --exclude-patterns                                      TEXT     List of patterns to exclude in the cataloge build                                                   │
│                                                                     [default: */files/*, */latest, .cmorout/*, */NorCPM1/*, */NorESM1-F/*, */NorESM2-LM/*,              │
│                                                                     */NorESM2-MM/*]                                                                                     │
│    --config-filepath                                       TEXT     Yaml file to configure build arguments [default: None]                                              │
│    --nthreads                                              INTEGER  Number of threads to use when building the catalog [default: 1]                                     │
│    --compression               --no-compression                     Whether to compress the output csv file [default: no-compression]                                   │
│    --install-completion                                             Install completion for the current shell.                                                           │
│    --show-completion                                                Show completion for the current shell, to copy it or customize the installation.                    │
│    --help                                                           Show this message and exit.                                                                         │

nirddmc's People

Contributors

ovewh avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.