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
|
Installation
============
Dependencies
------------
- ECCODES_ C library.
- `numpy <http://www.numpy.org/>`__
- `pyproj <https://pyproj4.github.io/pyproj/stable>`__
- `cython <https://cython.org>`__ (only needed at build-time)
Instructions
------------
The easiest way to get everything installed (on macosx and linux) is to use pip_:
>>> pip install pygrib
This will install all the dependencies for you (including the ECCODES_ C lib).
If you're using Anaconda python (recommended for Windows), use conda_:
>>> conda install -c conda-forge pygrib
If using conda on windows, you may also need to set the ``ECCODES_DEFINITION_PATH``
environment variable to ``$CONDA_PREFIX/Library/share/eccodes/definitions`` if you see
an error saying ``boot.def`` cannot be found.
.. _pip: http://pip.pypa.io/
.. _conda: http://conda.io/
.. _ECCODES: https://confluence.ecmwf.int/display/ECC/
Developing
----------
To build from source, clone the github repository and run setup.py:
>>> git clone https://github.com/jswhit/pygrib
>>> cd pygrib
>>> ECCODES_DIR=path/to/eccodes python setup.py install
where ``$ECCODES_DIR`` is the path to the directory containing ``include/grib_api.h``
and ``lib/libeccodes.so``. If ``ECCODES_DIR`` is not specified, a few common locations
such as ``$CONDA_PREFIX,/usr,/usr/local,/opt/local`` will be searched..
Then run the simple test script to check if things are working
``cd test; python test.py``.
To be able to run all the tests, install pytest_ and run
>>> export MPLBACKEND=agg
>>> cd test
>>> pytest test*py --mpl --mpl-baseline-path=baseline_images
Many tests require matplotlib_, pytest-mpl_ and cartopy_. If you don't want to install
those, just run ``test.py`` and ``test_latlons.py``.
.. _pytest: http://pytest.org
.. _pytest-mpl: https://pypi.org/project/pytest-mpl/
.. _matplotlib: https://matplotlib.org
.. _cartopy: https://scitools.org.uk/cartopy/docs/latest/
|