https://github.com/ncar/chromag-pipeline

Data processing pipeline for ChroMag
https://github.com/ncar/chromag-pipeline

chromag hao mlso pipeline python

Last synced: 15 days ago
JSON representation

Data processing pipeline for ChroMag

• Host: GitHub
• URL: https://github.com/ncar/chromag-pipeline
• Owner: NCAR
• Created: 2018-07-18T17:24:05.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-04-08T21:28:46.000Z (about 1 year ago)
• Last Synced: 2025-04-08T22:19:48.654Z (about 1 year ago)
• Topics: chromag, hao, mlso, pipeline, python
• Language: Python
• Homepage:
• Size: 136 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.rst

Awesome Lists containing this project

README

          
# ChroMag calibration pipeline

[![Documentation Status](https://readthedocs.org/projects/chromag/badge/?version=latest)](https://chromag.readthedocs.io/en/latest/?badge=latest)

## Requirements

- Python 3.7 or later

## Installation

See the [Installation guide].

## Running

``` bash

$ chromag --help

usage: chromag [-h] [-v] {cat,log,ls,end-of-day,eod} ...

ChroMag pipeline 0.1.0

positional arguments:

  {cat,log,ls,end-of-day,eod}

                        sub-command help

    cat                 display file header

    log                 display, and optionally filter, log output

    ls                  list files with extra ChroMag-specific info

    end-of-day (eod)    run end-of-day pipeline

options:

  -h, --help            show this help message and exit

  -v, --version         show program's version number and exit

```

Help for each sub-command can be obtained as well, e.g.:

``` bash

$ chromag eod --help

usage: chromag end-of-day [-h] [-f CONFIGURATION_FILENAME] [date-expr ...]

positional arguments:

  date-expr             dates to run on in the form YYYYMMDD including lists (using commas) and

                        ranges (using hyphens where end date is not included)

options:

  -h, --help            show this help message and exit

  -f CONFIGURATION_FILENAME, --configuration-filename CONFIGURATION_FILENAME

                        Configuration filename

```

## Development

### Testing

To run the unit tests, use `pytest`:

``` bash

pytest tests

```

The unit tests will automatically be run before a commit is allowed.

### Linting

To get perform static analysis on the source code to check for common patterns

that might cause errors or other problems, run `pylint` from the root directory

of the repository:

``` bash

pylint chromag tests

```

[Installation guide]: INSTALLATION.rst