Installation#
Dependencies#
Dependency |
Use |
|---|---|
python >=3.9 |
mandatory |
mandatory |
|
mandatory |
|
mandatory for using the null space optimization algorithm |
|
mandatory for using the GUI application OpenPisco |
|
mandatory for using the GUI application OpenPisco |
|
mandatory for using the GUI application OpenPisco |
|
mandatory for remeshing and running body-fitted topology optimization |
|
mandatory for using the level set advection algorithm |
|
mandatory for using the level set redistancing algorithm |
|
optional finite element external software |
|
optional finite element external software |
|
optional finite element external software |
|
optional cell-centered finite volume external software |
|
mandatory for using the Code_Aster interface |
Install the last stable release with conda/mamba#
Users can install the minimal version with the conda package with
mamba create -n OpenPiscoBaseEnv --override-channels -c conda-forge openpisco-core=1.3.0
Users can install openpisco together with dependencies (except for finite element external solvers) with
mamba create -n OpenPiscoEnv --override-channels -c conda-forge openpisco=1.3.0
So far, OpenPisco has been successfully installed and tested with the following operating system types:
Linux: Ubuntu
MacOs
Windows: 10 and wsl (20.04)
Note
Some optional dependencies (iscd-mshdist,iscd-advection) are not packaged for Windows as of now. For Windows users, a convenient alternative could be WSL, for instance.
Install external finite element solvers#
External finite element solvers (Code_Aster,FreeFem,Zset) must be installed and available from the command line in order to interface them with OpenPisco.
Install Code_Aster#
The package libmed is needed for using the OpenPisco interface to Code_Aster and can be installed with
mamba install -c conda-forge libmed
To install Code_Aster it is recommended to visit the Code_Aster installation guide. Alternatively, a Code_Aster conda package is available within the conda-forge and can be installed with
mamba install -c conda-forge code-aster
To avoid conflicts between Code_Aster and your current conda environment, it is recommanded to have a dedicated conda environment for Code_Aster alone. Thus, in order to be able to use this solver, the only remaining step is to define a suitable environment variable
export ASTER_EXECUTABLE="conda run -n YourStandaloneAsterEnv as_run"
For issues regarding the installation of Code_Aster it is strongly recommended to contact the Code_Aster maintainers.
Install FreeFem#
To install FreeFem it is recommended to visit the FreeFem installation guide . Alternatively, a FreeFem conda package is provided within the OpenPisco anaconda channel and can be installed with
mamba install -c openpisco freefem
For issues regarding the installation of FreeFem it is strongly recommended to contact the FreeFem maintainers.
Install ZSet#
To install ZSet it is recommended to visit the ZSet installation guide. For issues regarding the installation of ZSet it is strongly recommended to contact the Zset maintainers.
Install external finite volume solver#
External cell-centered finite volume solver (OpenFOAM) must be installed and available from the command line in order to interface them with OpenPisco.
Install OpenFOAM#
To install OpenFOAM v12, it is recommended to visit the Compiling OpenFOAM from Source Code. Alternatively, an OpenFOAM v12 apt package for ubuntu (20.04 LTS, 22.04 LTS and 24.04 LTS) is available and it is recommended to visit the Installing OpenFOAM from apt package.
Testing#
To test your installation, activate the OpenPiscoEnv environment and run
python -m Muscat -e OpenPisco
Note that some tests can be disabled using an environment variable, for example when a test relies on an external dependency that may not be available on your system/environment. The feature relies on the definition of non-empty environment variables of the form:
"appsname_NO_FAIL"
where appsname can take one of the following values
ZSET
ASTER
MED
FREEFEM
FOAM