Skip to content

gthyagi/underworld3

 
 

Repository files navigation

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.

The development branch has similar documentation:

Binder demonstration version

Binder

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

Releases

No releases published

Packages

No packages published

Languages

  • HTML 94.7%
  • TeX 3.8%
  • Python 1.0%
  • Cython 0.2%
  • Jupyter Notebook 0.2%
  • C++ 0.1%