Installing dolfin-adjoint

Note: If you are looking to install the (deprecated) dolfin-adjoint/libadjoint library, visit the dolfin-adjoint/libadjoint webpage.

What is the difference between dolfin-adjoint/pyadjoint and dolfin-adjoint/libadjoint?

Source code

The source code of pyadjoint is available on https://bitbucket.org/dolfin-adjoint/pyadjoint.

Docker images (all platforms)

Docker allows us to build and ship consistent high-performance dolfin-adjoint installations with FEniCS for almost any platform. To get started, follow these 2 steps:

  1. Install Docker. Mac and Windows users should install the Docker Toolbox (this is a simple one-click install) and Linux users should follow these instructions.

  2. Install the FEniCS Docker script:

    curl -s https://get.fenicsproject.org | bash
    

If running on Mac or Windows, make sure you run this and other commands inside the Docker Quickstart Terminal.

Stable version:

Once both Docker and the FEniCS Docker script have been installed, you can easily start a FEniCS session with dolfin-adjoint by running the following command:

fenicsproject run quay.io/dolfinadjoint/pyadjoint

A Jupyter notebook instance with a user defined name (here myproject) can be started with:

fenicsproject notebook myproject quay.io/dolfinadjoint/pyadjoint
fenicsproject start myproject

The FEniCS Docker script can also be used to create persistent sessions:

fenicsproject create myproject quay.io/dolfinadjoint/pyadjoint
fenicsproject start myproject

Development version:

The development version of dolfin-adjoint and FEniCS is available with:

fenicsproject run quay.io/dolfinadjoint/dev-pyadjoint

To update the development container, run:

fenicsproject pull quay.io/dolfinadjoint/dev-pyadjoint

To see all the options run:

fenicsproject help

For more details and tips on how to work with FEniCS and Docker, see our FEniCS Docker page.