Installation

This part of the documentation covers the installation of GEOLib+. The first step to using any software package is getting it properly installed.

GEOLib+ installation

Geolib+ can be installed from PyPi:

$ pip install d-geolib_plus

GEOLib+ releases are also available from publicwiki.deltares.nl and github as .whl files. You can download these and install such files with:

$ pip install geolib_plus-0.1.2-py3-none-any.whl

To install the latest GEOLib+ simply the following command:

$ pip install git+git@github.com:Deltares/geolib-plus.git

Warning

Note that installation of the GEOLib+ package and GEOLib with a python version newer than 3.9 might lead to package conflicts between the two libraries. And might require the reinstallation of a few of those packages. This problem is using caused by version 1.6.2 of the pydantic package which is not compatible with 3.9 Python version. Upgrading to pydantic version 1.8.2 seems to solve this problem.

Packages used

The main packages used are:

  • Lxml Powerful and Pythonic XML processing library combining libxml2/libxslt with the ElementTree API.

  • Matplotlib Python plotting package

  • Numpy NumPy is the fundamental package for array computing with Python.

  • Pandas Powerful data structures for data analysis, time series, and statistics

  • Poetry for package management (replacing setuptools) see also PEP 518.

  • Pydantic for validation of types and some parameters (min/max/defaults).

  • Pyproj Python interface to PROJ (cartographic projections and coordinate transformations library)

  • Scipy SciPy: Scientific Library for Python

  • Shapely Geometric objects, predicates, and operations

You don’t need to install anything manually, as the pip installation should take care of it.

Get the Source Code

GEOLib+ is actively developed on BitBucket, where the code is always available.

You can either clone the public repository:

$ git clone git@bitbucket.org:DeltaresGEO/geolib-plus.git

Once you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:

$ cd geolib-plus
$ pip install poetry
$ poetry install