Installation

Lizzy is available on PyPI. To install:

(.venv) $ pip install lizzy-lib

You can check that the installation was successful by typing:

(.venv) $ lizzy
>>>
       |    _)
       |     | _  / _  /  |  |
      ____| _| ___| ___| \_, |
                         ___/
               v0.1.0

PETSc solvers (optional)

Lizzy leverages the PETSc library for some of its faster solvers. This installation is optional and not included by default. To use PETSc solvers, you need to install PETSc and its Python bindings PETSc4py in the same environment where Lizzy is installed:

(.venv) $ pip install petsc petsc4py

You can check at any time if PETSc is installed correctly by typing:

(.venv) $ lizzy info
>>>
       |    _)
       |     | _  / _  /  |  |
      ____| _| ___| ___| \_, |
                         ___/
               v0.1.0

Lizzy LCM simulation library - v0.1.0

Developed by S. Bancora and P. Mulye, Copyright 2025-2026
Licensed under the GNU General Public License v3.0

Optional dependencies:
PETSc solvers: installed
>>>

Note

If you are using Windows, installing PETSc might be challenging. We recommend to use the Windows Subsystem for Linux 2 (WSL2) to install a Linux environment on your Windows machine, and then follow the Linux installation instructions for PETSc. Alternatively, PETSc can be manually built from source (advanced).