Installation

⚠️ Some problems run under Docker or Singularity. Others require native installation of dependencies, please consult the documentation of the specific problem.

From PyPI

pip install engibench

You can also specify additional dependencies for specific problems:

pip install "engibench[beams2d]"

Or you can install all dependencies for all problems:

pip install "engibench[all]"

From source

To install EngiBench for development, clone the repo, install the pre-commit hooks, and install all dev dependencies:

git clone git@github.com:IDEALLab/EngiBench.git
cd EngiBench
pre-commit install
pip install -e ".[dev]"

Our pre-commit config also includes a hook to ensure compliance with conventional commit formatting (see CONTRIBUTING.md).

Also worth installing ruff and mypy in your editor as we are checking the code style and type safety on our CI.