pSi3D is a semi-implicit 3D hydrodynamic model written in Fortran 90 and parallelized for computation across CPU threads using the OpenMP directive framework. For more technical details regarding governing equations and numerical schemes, see this paper.

Compilation of the source code requires an environment configured with the Intel Fortran Compiler (ifort) and OpenMP (bundled with ifort in the Intel oneAPI HPC Toolkit).

To download the source code, clone the repository:

git clone https://github.com/SI3DL/psi3d.git
cd psi3d

Then, to compile the source code into a binary file (psi3d), simply run

bash ./Compiler.sh

This should create a psi3d binary in the working directory (Note: you may need to chmod for execution permissions).

The pSi3D repository comes with template input files for setting up a model (./SampleFiles/) as well as an sample model run (./sampleRuns/windDrivenFlow). Details for this sample model are included as a readme.txt file in its subdirectory.

To run the sample model, simply copy the psi3d binary to the sample run directory and execute it:

cp ./psi3d ./sampleRuns/windDrivenFlow/
cd ./sampleRuns/windDrivenFlow/
./psi3d

The terminal will stream information as the program runs and model logs/outputs will be stored in the working directory.

For more details regarding how to setup models, prepare input files, and analyze outputs, see the Si3D user manual.

Users are welcome to report any issues/bugs on the GitHub Issues page.

Contributions to pSi3D are welcome. Please reach out to the current developers for contribution guidelines.