1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
# odc
[](https://github.com/ecmwf/odc/actions/workflows/ci.yml)
[](https://odc.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/ecmwf/odc/blob/develop/LICENSE)
[](https://pypi.org/project/odclib/)
C, C++ and Fortran libraries providing encoders and decoders and interrogation of meteorological data encoded in ODB-2 format as well as command line tools for investigation and manipulation of ODB-2 data.
[Documentation]
## Dependencies
### Required
* C or C++ compiler
* [CMake]
* [ecbuild]
* [eckit]
### Optional
* Fortran compiler
* [Doxygen]
## Installation
```sh
git clone https://github.com/ecmwf/odc
cd odc
# Setup environment variables (edit as needed)
SRC_DIR=$(pwd)
BUILD_DIR=build
INSTALL_DIR=$HOME/local
export eckit_DIR=$INSTALL_DIR # set to eckit install prefix
# Create the the build directory
mkdir $BUILD_DIR
cd $BUILD_DIR
# Run ecbuild (CMake)
ecbuild --prefix=$INSTALL_DIR -- $SRC_DIR
# Build and install
make -j10
make test # optional
make install
# Check installation
$INSTALL_DIR/bin/odc --version
```
## Usage
Include the `odc` headers like so:
```c
// odc_test.c
#include "odc/api/odc.h"
int main() {
odc_initialise_api();
return 0;
}
```
Make sure to reference the linked library when compiling:
```sh
gcc -lodccore odc_test.c
```
## Build Documentation
The documentation is generated using Sphinx.
First, make sure that `Doxygen` module is available, and then install Python dependencies in your environment:
```sh
cd docs
pip install -r requirements.txt
```
You can then build the documentation by using **make**:
```sh
cd docs
make html
```
The built HTML documentation will be available under the `docs/_build/html/index.html` path.
## Licence
This software is licensed under the terms of the Apache Licence Version 2.0 which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
In applying this licence, ECMWF does not waive the privileges and immunities granted to it by virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
[Documentation]: https://odc.readthedocs.io/en/latest/
[CMake]: https://cmake.org
[ecbuild]: https://github.com/ecmwf/ecbuild
[eckit]: https://github.com/ecmwf/eckit
[Doxygen]: https://www.doxygen.nl
|
