Installing the G-ADOPT library

First of all, you need to install Firedrake, the finite element framework underpinning G-ADOPT. Firedrake is available for Ubuntu, Mac, and, in principle, other Linux and Linux-like systems.

You can install both Firedrake and G-ADOPT by running:

curl -O https://raw.githubusercontent.com/firedrakeproject/firedrake/master/scripts/firedrake-install
python3 firedrake-install --install gadopt

More detailed instructions for installing Firedrake and suggestions for troubleshooting can be found on the Download page of the Firedrake website. Note that the install procedure may take up to one hour depending on your system.

Using the G-ADOPT library

If you would like to run G-ADOPT through scripts or interactively, simply ensure that your Firedrake environment is activated:

source firedrake/bin/activate

Furthermore, the gadopt Python module should be available for you to use.

Run the tutorials

The G-ADOPT tutorials are located within the G-ADOPT GitHub repository. If you would like to experiment with them, there are a few more requirements for your Firedrake environment.

First, activate the Firedrake environment so that the requirements will be installed into it:

source firedrake/bin/activate

Next, install Jupyter Notebook and the optional G-ADOPT requirements:

python3 -m pip install notebook gadopt[demos]

Finally, clone the G-ADOPT repository to access the demos:

git clone https://github.com/g-adopt/g-adopt

Now you should be ready to test the installation and run the first tutorial! Start the notebook server:

jupyter notebook

Within the browser window that pops up, you can browse to the g-adopt/demos directory and open any Python script with the .py extension as a notebook.

Visualisation software

Firedrake can output data in VTK format, suitable for viewing in Paraview. On Ubuntu and similar systems, you can obtain Paraview by installing the paraview package. On Mac OS the easiest approach is to download a binary from the paraview website.

Optional install

To bring in the optional nonlinear optimisation dependencies you should activate the virtual environment of an existing Firedrake installation and then install the optimisation variant:

pip install gadopt[optimisation]

Developing G-ADOPT

If you are keen to make changes to the core G-ADOPT code (and you want to work in a separate directory to Firedrake's default location for G-ADOPT), you should first clone the G-ADOPT GitHub repository:

git clone https://github.com/g-adopt/g-adopt.git

After activating the virtual environment of an existing Firedrake installation, you can then install G-ADOPT with:

pip install -e g-adopt/

The editable, -e, flag means that any updates you make to this directory will be reflected directly in the Firedrake virtual environment.