https://github.com/dmidk/metest
Test, check and compare logs and data from meteorological computations.
https://github.com/dmidk/metest
Last synced: 2 months ago
JSON representation
Test, check and compare logs and data from meteorological computations.
- Host: GitHub
- URL: https://github.com/dmidk/metest
- Owner: dmidk
- License: mit
- Created: 2021-08-26T07:56:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-27T12:19:57.000Z (almost 5 years ago)
- Last Synced: 2025-10-30T11:03:46.552Z (7 months ago)
- Language: Python
- Size: 295 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```sh
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:
```sh
python setup.py sdist bdist_wheel
```
To install locally:
```sh
pip install dist/metest-$VERSION-py3-none-any.whl --upgrade
```
To deploy to PyPi (Only users with access can do this):
```sh
python -m twine upload dist/*
```