Installation¶

You can install the Null Space Optimizer with pip or by cloning the sources from the gitlab repository.

Installation Requirements¶

For installing Null Space Optimizer, a python executable (version >=3.6) needs to be installed and available from the command line.

If you don’t install Null Space Optimizer with pip, you will also need to manually install the following python packages:

numpy (>=1.23.4)
matplotlib (>=3.6.2)
scipy (>=1.9.3)
cvxopt (>=1.3.0)
osqp (>=0.6.2)
sympy (>=1.3.0)
qpalm (>=1.2.2)
colored (>=1.4.4)
pypardiso (>=0.4.7)

This is the easiest way to get the latest stable version and to install python dependencies.

bash

pip install nullspace_optimizer

Clone the repository using the command line prompt:

console

git clone https://gitlab.com/florian.feppon/null-space-optimizer.git

Then add the nullspace_optimizer folder to your $PYTHONPATH:

bash .bashrc¶

export PYTHONPATH="$PYTHONPATH:/path/to/nullspace_optimizer"

or install the module locally with pip:

bash

pip install -e /path/to/nullspace_optimizer

where /path/to/nullspace_optimizer is the directory where Null Space Optimizer has been cloned.

If you want to run the topology optimization examples from the examples/topopt_examples, you also need to install the following dependencies:

IPOPT and its Python wrapper cyipopt. Building from source is recommended.
pymedit
FreeFEM and its Python interface PyFreeFEM. Building FreeFEM from source is also recommended. An installation recipe for Linux systems is described here.