Installation

Important

fem2geo supports Python 3.10 to 3.13.

Latest

Recommended for trying the newest features, following development, or contributing back.

Clone the repository:

$ git clone https://github.com/pabloitu/fem2geo
$ cd fem2geo

Create and activate a virtual environment, then install in editable mode:

$ python -m venv venv
$ source venv/bin/activate
$ pip install -e .

Stable (PyPI)

Recommended for regular use.

Create and activate a virtual environment, then install from PyPI:

$ python -m venv venv
$ source venv/bin/activate
$ pip install fem2geo

Tutorials

Tutorials are distributed separately from the PyPI package. To download the tutorials from the latest GitHub release into your current directory:

$ fem2geo download-tutorials

This will download and extract the tutorials into ./tutorials.

For contributing to fem2geo, install with the dev extras. This adds the testing and documentation dependencies.

$ git clone https://github.com/pabloitu/fem2geo
$ cd fem2geo
$ python -m venv venv
$ source venv/bin/activate
$ pip install -e ".[dev]"

From the repository root, with the dev environment active:

$ pytest tests/

From the repository root, with the dev environment active:

$ make clean
$ make html

Open docs/build/html/index.html in a browser to preview it.