smyalygames/FiniteVolumeGPU_HIP
1
0
Fork 0
mirror of https://github.com/smyalygames/FiniteVolumeGPU_HIP.git synced 2025-05-18 06:24:11 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Hicham Agueny 2024-06-09 23:18:17 +02:00
parent b1dc2938ad
commit b8603e939e
1 changed files with 1 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,22 +2,6 @@
This is a HIP version of the [FiniteVolume code](https://github.com/babrodtk/FiniteVolumeGPU) (work in progress). It is a Python software package that implements several finite volume discretizations on Cartesian grids for the shallow water equations and the Euler equations.
## Setup
A good place to start exploring this codebase is the notebooks. Complete the following steps to run the notebooks:
1. Install conda (see e.g. Miniconda or Anaconda)
2. Change directory to the repository root and run the following commands
3. conda env create -f conda_environment.yml
4. conda activate ShallowWaterGPU
5. jupyter notebook
Make sure you are running the correct kernel ("conda:ShallowWaterGPU"). If not, change kernel using the "Kernel"-menu in the notebook.
If you do not need to run notebooks you may use the conda environment found in conda_environment_hpc.yml
## Troubleshooting
Have a look at the conda documentation and https://towardsdatascience.com/how-to-set-up-anaconda-and-jupyter-notebook-the-right-way-de3b7623ea4a
## Setup on LUMI-G
Here is a step-by-step guide on installing packages on LUMI-G