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
|
Installation
============
.. index:: Dependencies
Dependencies
------------
.. index::
single: Dependencies; Required
Required
^^^^^^^^
* Python 3.x
.. index:: Dependencies; Optional
Optional
^^^^^^^^
* `odc`_ (>= 1.4.0)
* `Jupyter Notebook`_
.. note::
For **codc** to work, the **odc** library must be compiled and installed on the system and made available to Python (through the CFFI mechanism) as a shared library. There are multiple ways to make the library visible to CFFI: it can be installed as a system library, the installation prefix can be passed in the ``odc_DIR`` or ``ODC_DIR`` environment variables, or the library directory can be included in ``LD_LIBRARY_PATH``. For example, if you cloned the odc source code to `$HOME/odc` and used `$HOME/odc/build` as the builddir, you could use `export odc_DIR=$HOME/odc/build`.
.. _`odc`: https://github.com/ecmwf/odc
.. _`Jupyter Notebook`: https://jupyter.org
.. index:: Installation
single: Installation; PyPI
Python Package Installer
------------------------
Install the package via `PyPI`_:
.. code-block:: shell
pip install pyodc
.. index::
single: Installation; Conda Forge
Conda Forge
-----------
Install the package in `Conda`_ environment via `conda-forge`_ channel:
.. code-block:: shell
conda install -c conda-forge pyodc
.. note::
To use **codc** module, you can install an optional **odc** dependency via **conda-forge** channel:
.. code-block:: shell
conda install -c conda-forge odc
Check Installation
------------------
To check if the modules were installed correctly:
.. code-block:: shell
python
>>> import pyodc
>>> import codc # optional
.. _`PyPI`: https://pypi.org
.. _`Conda`: https://docs.conda.io
.. _`conda-forge`: https://conda-forge.org
|
