mirror of
https://github.com/MeteoSwiss/fdb-utils.git
synced 2026-08-26 11:54:22 +00:00
Read-only mirror of https://github.com/MeteoSwiss/fdb-utils — MeteoSwiss. Issues & pull requests at the source.
- Python 98.8%
- Dockerfile 1.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| doc | ||
| fdb_utils | ||
| jenkins | ||
| test | ||
| .gitignore | ||
| .mch-ci.yml | ||
| .python-version | ||
| Dockerfile | ||
| HISTORY.rst | ||
| Jenkinsfile | ||
| LICENSE | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.rst | ||
| sonar-project.properties | ||
fdb-utils
###########
Python library for users and admins of `FDB <https://github.com/ecmwf/fdb>`_.
Installation
--------------
Dependencies
============================
FDB Utils depends on the FDB and Eccodes libraries, these are not installed with pip. The following environment variables need to be set:
.. code-block:: console
export FDB5_CONFIG_FILE=<path/to/fdb-config.yaml>
export FDB5_DIR=<path/to/fdb/home>
export ECCODES_HOME=<path/to/eccodes/home>
See `MeteoSwiss Confluence <https://meteoswiss.atlassian.net/wiki/x/gY_XC>`_ for the environment variables to use for MeteoSwiss's realtime FDB (at CSCS).
Install the package from PyPI (MeteoSwiss Nexus, see `how to setup Nexus PyPI access from CSCS <https://meteoswiss.atlassian.net/wiki/x/XogHAQ>`_)
.. code-block:: console
pip install fdb-utils
.. code-block:: console
fdb-utils --help
Development
--------------------
Setup virtual environment
.. code-block:: console
cd fdb-utils
poetry install
Run tests
.. code-block:: console
poetry run pytest
Run tests within the uenv
.. code-block:: console
uenv start --view=realtime fdb/5.18:<latest_version>
poetry install
poetry run pytest
Generate documentation
.. code-block:: console
poetry run sphinx-build doc doc/_build
Then open the index.html file generated in *fdb-utils/build/_build/*
Build wheels
.. code-block:: console
poetry build