Skip to content

Latest commit

 

History

History
92 lines (72 loc) · 2.03 KB

README.md

File metadata and controls

92 lines (72 loc) · 2.03 KB

Proteus

Proteus is a MOOSE based application for multiphysics simulation. It is focussed on fluid dynamics and its commonly coupled domains.

Installation

Windows

Proteus can be run on Windows by using the Windows Subsystem for Linux (WSL) and following the instructions for Ubuntu or Linux below.

Ubuntu

There is an automated build and install process for Ubuntu, which can be run using the following commands:

git clone https://github.com/aurora-multiphysics/proteus
cd proteus
./scripts/install_ubuntu_prerequisites.sh
./scripts/install_ubuntu.sh

Please read the install script and verify you understand and are comfortable with what it is doing. Once Proteus is built using this script, you can use Proteus to run an input file as follows:

source ~/.proteus_profile
proteus-opt -i <input-file>.i

Other Linux

Install MOOSE by following the instructions on the MOOSE homepage.

Once MOOSE is installed, change to the proteus directory and run:

make

After this completes successfully, use Proteus to run an input file as follows:

./proteus-opt -i <input-file>.i

Building Using Multiple Cores

The install process above can be sped up by using multiple cores during the build process. Note that this will also need more memory and to ensure the build goes smoothly, we recommend having at least 4GB per core. Multiple cores are enabled by setting the MOOSE JOBS environment variable before running the install script:

export MOOSE_JOBS=4

Where the number 4 in the example above corresponds to using four cores.

Docker

Proteus can be run in a container to make installation easier.

Run this command in the /docker directory to build the image.

docker build --rm -t proteus:latest .

Contributors

Aleksander J. Dubas, UK Atomic Energy Authority

Rupert W. Eardley-Brunt, UK Atomic Energy Authority

Luke Humphrey, UK Atomic Energy Authority

Alexander Whittle, UK Atomic Energy Authority