underworld3

Documentation

The underworld documentation is in two parts: the user manual / theory manual is a jupyterbook that is built from this repository automatically from the sources in the Jupyterbook directory. The api documentation is also autogenerated.

• https://underworldcode.github.io/underworld3/main/FrontPage.html
• https://underworldcode.github.io/underworld3/main_api/index.html

The development branch has similar documentation:

• https://underworldcode.github.io/underworld3/development/FrontPage.html
• https://underworldcode.github.io/underworld3/development_api/index.html

Binder demonstration version

Binder - Dev Branch

Building

Refer to the Dockerfile for uw3 build instructions.

To install from the repository

pip install .

The in-place pip installation may be helpful for developers (after the above)

pip install -e .

To clean the git repository or all files ... be careful.

./clean.sh

Testing

Run the script

./test.sh