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 105 106
|
Installation
============
.. index:: Dependencies
Dependencies
------------
.. index::
single: Dependencies; Required
Required
~~~~~~~~
* C or C++ compiler
* `CMake`_
* `ecbuild`_
* `eckit`_
.. index:: Dependencies; Optional
Optional
~~~~~~~~
* Fortran compiler
* `Doxygen`_
.. index:: Build, Install
:name: build-install
Build & Install
---------------
.. code-block:: shell
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
.. index:: Build; Optional Features, Install; Optional Features
Optional Features
~~~~~~~~~~~~~~~~~
Fortran interface is an optional feature, and requires an activation flag to be set during build configuration:
.. code-block:: shell
ENABLE_FORTRAN=ON
ecbuild --prefix=$INSTALL_DIR -- -DENABLE_FORTRAN=$ENABLE_FORTRAN $SRC_DIR
.. index::
single: Install; Conda Forge
Conda Forge
-----------
Alternatively, you can install **odc** package in `Conda`_ environment via `conda-forge`_ channel:
.. code-block:: shell
conda install -c conda-forge odc
.. note::
Installing **odc** via **conda-forge** channel will provide Fortran interface out of the box.
Check if the package was installed correctly:
.. code-block:: shell
odc --version
.. _`CMake`: https://cmake.org
.. _`ecbuild`: https://github.com/ecmwf/ecbuild
.. _`eckit`: https://github.com/ecmwf/eckit
.. _`Doxygen`: https://www.doxygen.nl
.. _`Conda`: https://docs.conda.io
.. _`conda-forge`: https://conda-forge.org
|