Skip to content

Installation

Installation

Solvis is intended to be used in the context of spatial data analysis, and as such has dependencies on libraries like NumPy, GeoPandas.

Solvis requires Python, and at the time of writing supports the following versions:

python

Depending on your use case, you may also wish to install Shapely and PyVista for certain functions (e.g. geometry.section_distance.)

For easy package installation, either pip or poetry is recommended.

Stable release

A stable release of the Solvis package can be installed from the Python Package Index (PyPI).

Using pip

$ pip install solvis

Or to include scripts dependencies and PyVista with the Visualization Toolkit (VTK): 

$ pip install solvis[scripts,vtk]

Adding to a poetry project

$ poetry add solvis

or to include the extras:

$ poetry add solvis[scripts,vtk]

From source code

The source code for solvis can be downloaded from the Github repository.

You can clone down the public repository with:

$ git clone https://github.com/GNS-Science/solvis.git

Once you have a copy of the source, you can install the package into your Python environment:

$ pip install .

Or with Poetry (using --all-extras to install all extra dependencies is recommended for development): 

$ poetry install --all-extras