dmidk / metest

Test, check and compare logs and data from meteorological computations.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

metest

Test, check and compare logs and data from meteorological computations.

Install using pip: pip install metest

Usage

Submodules can be imported, but this software is designed to be used as a CLI (Command-Line-Interface), by calling the __main__ module.

python -m metest: Prints a help message

python -m metest logmetric: Calls the logmetric submodule and prints a help message (as flags are needed for this command to work)

python -m metest logmetric -m harmonie --individual -f /path/to/log -o /home/$USER/: Computes standard metrics on a single logfile from Harmonie and output results to /home/$USER/

Documentation

Documentation is auto-build from in-line code using sphinx: dmidk.github.io/metest/

Prerequisites

metest is a script tool based on python. Dependencies is defined in metest.yml and a python environment can be made using (mini)conda:

conda env create -f metest.yml

For developers

Build documentation

cd doc
sphinx-apidoc -f --private --ext-autodoc --separate -o . ../metest/
make html

The html source files goes into doc/_build/html

Build package

To build from the source code:

python setup.py sdist bdist_wheel

To install locally:

pip install dist/metest-$VERSION-py3-none-any.whl --upgrade

To deploy to PyPi (Only users with access can do this):

python -m twine upload dist/*

About

Test, check and compare logs and data from meteorological computations.

License:MIT License


Languages

Language:Python 100.0%