Skip to content

underworldcode/underworld3

Repository files navigation

underworld3

Welcome to Underworld3, a mathematically self-describing, finite-element code for geodynamic modelling. This quick-start guide has basic installation instructions and a brief introduction to some of the concepts in the Underworld3 code.

All Underworld3 source code is released under the LGPL-3 open source licence. This covers all files in underworld3 constituting the Underworld3 Python module. Notebooks, stand-alone documentation and Python scripts which show how the code is used and run are licensed under the Creative Commons Attribution 4.0 International License.

Documentation

Start with the online Quick Start Guide for a brief overview of the code.

The underworld3 module (API) documentation can be found online:

Binder demonstration version

Installation Guide

The quickest option is not to install anything but try the binder demo above !

If do you want to install the code on your own machine, we recommend using miniconda and mamba. Create a separate virtual environment and install the code from source. More details on how to do that are in the Installation Instructions