Installation

To install the dream package clone the repository to your local machine.

(dream) user:~$ git clone git@github.com:plederer/dream_solver.git ~/target-path

Run the following command in the directory of the git repository:

(dream) user:~$ python3 -m pip install -e ~/target-path/.

This will install the dream package and all its dependencies from pip including ngsolve.

Tip

We advice the use of a virtual environment for the installation of the dream package and its dependencies.

To setup and activate a virtual environment run the following commands:

user:~$ python3 -m venv ~/env-path/dream
user:~$ source ~/env-path/dream/bin/activate
(dream) user:~$  which python3
/home/user/env-path/dream/bin/python3

To deactivate the virtual environment run:

(dream) user:~$ deactivate
user:~$ 

Note

If the installation finds an underlying installation of ngsolve it will not install the package from pip, but use the existing installation.

Note

The dream package requires Python 3.10 and later versions.