-
Notifications
You must be signed in to change notification settings - Fork 5
Home
Welcome to the cerberus wiki! Please email k.c.tapinou@gmail.com for requests for enhancements to the wiki or make an issue.
(USYD students only, UQ apply through School of Mechanical and Mining Engineering ) https://forms.cloud.microsoft/Pages/ResponsePage.aspx?id=fuOzgnGBXUixCzja5-0UqP98_fnbeE9ElF5LxSBs_BlUOFM1RzBVNVFXNEZFRUFMTFBBTjlGU1E3SC4u
If you have a windows computer, use WSL. If Mac, there are options but I find them insufficient, use your local cluster. If you have linux then skip. Watch a tutorial on basic bash commands (this should be fine https://www.youtube.com/watch?v=cgVbqxtx3hU )
Install Paraview or VisIt from LLNL (recommended but steeper learning curve) on your computer
"git clone" the project into a directory (folder) on your machine or on the cluster directory.
Read the README.md and GETTING_STARTED.md documents. Don't forget to initialise submodules and link the EBGeometry module. To initialise submodules run:
git submodule update --init --recursive
NOTE the EBGeometry has recently been updated to a version that has clashes with the cerberus usage. Checkout the following commit from EBGeometry which is compatible with the existing functions used by cerberus.
EBGeometry compatible commit
commit 6736d5166c9a31a1f844533486654cc229cf317e (HEAD -> main, origin/main, origin/HEAD)
Author: Robert Marskar robert.marskar@sintef.no
Date: Mon Mar 2 11:23:18 2026 +0100
Fix bug in VTK binary reader (#87)
Go to the EBgeometry home and run
git checkout 6736d5166c9a31a1f844533486654cc229cf317e
Then link the EBGeometry directory to ceberus using a Make.local (copy the existing Make.local.template to a file called Make.local and edit the EBGEOMETRY_HOME path variable).
Run the “cerberus_install_packages.sh” in cerberus/Exec/local , this should read your installed packages and check which ones you need to add, it will then try to install them for you.
Note if you are working on a cluster you might be able to use the local module system to load the relevant packages e.g. if you are working on the USYD physics clusters then something like the following should suffice.
module load dev-utilities intel_ippcp_intel64 mpi export I_MPI_FABRICS=ofi
Python environments have generally superseded the old conda environment approach, they still work but you may benefit from a python environment. Still, you can use an AI to transcribe my old instructions into a python environment format. Really you just need the python environment equivalent of the following:
conda create -n cerberus_python python=3.10.12 numpy=1.26.4 scipy=1.12.0 matplotlib=3.5.1
conda activate cerberus_python
Otherwise put this file into an AI and ask it to give you python environment instructions: cerberus/Exec/python_analysis/install_conda.sh
Go to testing directory and run tests (cerberus/Exec/testing/)
python run_tests.py
Read some of the test case *.inputs and *.lua files to get a feel for how the structure to setup a simulation works. The run files are in run.sh in each directory.