Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Updated README.md #45

Merged
merged 1 commit into from
Feb 7, 2025
Merged

Minor: Updated README.md #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
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
8 changes: 8 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,11 @@ line_length = 120
skip_glob=".*"
skip = ["setup.py"]
src_paths = ["src", "tests"]

[tool.coverage.run]
source = [
"src/pyfdb/*",
]
include = [
"tests/*",
]
Loading