Skip to content

Commit

Permalink
Minor: Updated README.md
Browse files Browse the repository at this point in the history
README.md is now using the ecmwf badge and is sticking to the codex
rules defined in [Codex](https://github.com/ecmwf/codex).
  • Loading branch information
tbkr committed Feb 7, 2025
1 parent d982191 commit 4d35559
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# pyfdb

[![Static Badge](https://github.com/ecmwf/codex/raw/refs/heads/main/Project%20Maturity/emerging_badge.svg)](https://github.com/ecmwf/codex/raw/refs/heads/main/Project%20Maturity)
[![codecov](https://codecov.io/gh/ecmwf/pyfdb/branch/develop/graph/badge.svg)](https://codecov.io/gh/ecmwf/pyfdb/tree/develop)

This repository contains the source code and documentation of pyfdb, a python FDB client which interfaces the FDB5 library in the system.

:warning: This project is BETA and will be experimental for the foreseeable future. Interfaces and functionality are likely to change.

 
## 1. Installation
Expand All @@ -24,6 +26,19 @@ conda activate client
python -m pip install --upgrade git+https://github.com/ecmwf/pyfdb.git@master
```

Since eccodes version 2.37.0, the eccodes binaries are shipped with the python binary, which can
lead to some issues, especially if the locally installed stack of the software is executed. To
overcome this, export the following environment variable (this will use the locally installed version
of eccodes):

```bash
export ECCODES_PYTHON_USE_FINDLIBS=1
```

Other options can be found on the corresponding eccodes page of pypi:
[Eccodes - Pypi](https://pypi.org/project/eccodes/)


 
## 2. Example

Expand Down

0 comments on commit 4d35559

Please sign in to comment.