Installation

To install surfalize from PyPI run:

pip install surfalize

Surfalize offers optional dependencies for various functions, such as 3d plotting (3d), command line functionality (cli), running tests (tests) building the documentation (docs). The install, put the name of the optional dependency set in square brackets behind the package name. For instance, optional dependencies for 3d plotting can be installed like this:

pip install surfalize[3d]

Multiple optional dependencies can be specified with a comma:

pip install surfalize[3d,cli]

Or all optional dependencies can be installed using:

pip install surfalize[all]

Alternatively, you can clone the git repository, navigate to the root folder and run:

pip install .

You can also install directly from git via pip:

pip install git+https://github.com/fredericjs/surfalize.git

Optionally, you can specify the branch to install the latest updates from the develop branch:

pip install git+https://github.com/fredericjs/surfalize.git@develop