mirror of
				https://github.com/smyalygames/FiniteVolumeGPU.git
				synced 2025-10-31 13:07:41 +01:00 
			
		
		
		
	 Anthony Berg
		
	
	
		ce8e834771
		
	
	
	
	feat(gitignore): add generated files, Python, CUDA, and JetBrains to .gitignore
			Anthony Berg
		
	
	
		ce8e834771
		
	
	
	
	feat(gitignore): add generated files, Python, CUDA, and JetBrains to .gitignore
		
	
FiniteVolumeGPU
This Python software package 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:
- Install conda (see e.g. Miniconda or Anaconda)
- Change directory to the repository root and run the following commands
- conda env create -f conda_environment.yml
- conda activate ShallowWaterGPU
- 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
					Languages
				
				
								
								
									Jupyter Notebook
								
								98.5%
							
						
							
								
								
									Python
								
								0.9%
							
						
							
								
								
									Cuda
								
								0.3%
							
						
							
								
								
									C++
								
								0.2%
							
						
							
								
								
									Shell
								
								0.1%