Installation

The build of the code is currently tested on Python 3.8, 3.9, 3.10 and 3.11. The code is CI tested on environments provided by Github Actions such as Ubuntu-20.04, Ubuntu-latest, MacOS-latest, Windows-latest, refer to Compatibility-CI page for more details.

Setting up a Virtual Environment

It is recommended to create a virtual environment to install the package. You can create a virtual environment using the following command:

python3 -m venv venv
source venv/bin/activate

For conda users, you can create a virtual environment using the following command:

conda create -n fastvpinns python=3.8
conda activate fastvpinns

Installing via PIP

You can simply install the package using pip as follows:

pip install fastvpinns

On Ubuntu/Mac systems with libGL issues caused due to matplotlib or gmsh, please run the following command to install the required dependencies.

sudo apt-get install libgl1-mesa-glx

Installing from source

The official distribution is on GitHub, and you can clone the repository using

git clone https://github.com/cmgcds/fastvpinns.git

To install the package just type:

cd fastvpinns
pip install -e .