No description, website, or topics provided.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archive/benchmarks_plane Moved old benchmark scripts to archive folder Oct 21, 2016
benchmarks_generic/thread_affinities added thread affinity test benchmark Oct 9, 2018
benchmarks_plane split between MULE and SWEET parts Dec 10, 2018
benchmarks_sphere split between MULE and SWEET parts Dec 10, 2018
data/shaders_glsl Removed wrong coefficients Aug 10, 2017
doc Cleanups Oct 21, 2018
local_software further updates Dec 11, 2018
mule further updates Dec 11, 2018
mule_local fixes for travis Dec 11, 2018
scripts added parallelization affinities Oct 5, 2018
src Updated variable name Dec 9, 2018
tests more updates Dec 11, 2018
.env environemnt file for visual studio code Sep 28, 2018
.gitignore updated .gitignore Oct 19, 2018
.travis.yml updates for travis Dec 10, 2018
INSTALL updated non-source code stuff Aug 4, 2017
LICENSE Renamed license to make it github conformant Jan 29, 2016
Makefile added minor thing to the makefile Oct 9, 2018
README updated README Oct 3, 2018
SConstruct split between MULE and SWEET parts Dec 10, 2018
merge_with_origin.sh added script to merge with origin Jun 15, 2017
run_gdb.sh Rewriting of Antialiasing for linear and non-linear computations Jul 26, 2017
run_tests.sh updated test start script Nov 17, 2018
run_valgrind_helgrind.sh minor changes Nov 16, 2016
run_valgrind_memcheck.sh Bugfixes in 2nd order TS methods Jul 6, 2017
sconscript split between MULE and SWEET parts Dec 10, 2018

README

**************************
SWEET
**************************
Shallow Water Equation Environment for Tests, Awesome!

Official website now available: https://schreiberx.github.io/sweetsite

This library supports various kinds of simulations (not only Shallow Water)
on 2D surfaces. The currently supported surfaces are
  * the 2D torus (bi-periodic plane) and
  * the sphere

For discretization, we use the double FFT for the plane and Spherical Harmonics
on the sphere.


!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! Please have a look into the INSTALL instructions to see required libraries !
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!


**************************
File structure:
**************************

	archive/	Old stuff which should be still visible when checking out repository
	benchmarks_sphere/	Scripts for running benchmarks (numerical and HPC) on the sphere
	benchmarks_plane/	Scripts for running benchmarks (numerical and HPC) on the plane
	build/		Build directory, note, that also /tmp is used for storing object files
	data/		Data such as OpenGL shaders
	doc/		Documentation
	local_software/	3rd party software with installer scripts
			If you get compile errors, please checkout this directory
	package/	Used for creating tarballs to deploy to servers
	python_mods/	Python helper files
	src/		Source folder
	src/programs	Example programs
	src/unit_tests	Unit tests to validate SWEET
	src/include/libgl	Some visualization helper tools
	src/include/libmath	Some mathematical routines
	src/include/sweet	DUDE! That's SWEET!
	src/include/...		Plenty of other stuff

	run_tests_compile_all.sh	Test script to check compilation of programs
	run_tests_validation.sh		Test script to validate computations
	run_valgrind.sh		Convenient script to call valgrind with preset options (Useful for debugging)
	SConstruct	Required for compilation (scons)
	TODO		TODO list



**************************
Coding:
**************************

	Please read the coding conventions in doc/coding_conventions
	These conventions are suggestions.



**************************
SWEET Environment
**************************

	First of all, setup the environment variables correctly
	( !!!!!!!!!!!!!!!!!!!!! )
	( see also INSTALL file )
	( !!!!!!!!!!!!!!!!!!!!! )

	$ source ./local_software/env_vars.sh


**************************
Compilation on personal workstation:
**************************

	The compilation is then done by calling 'scons' which is a
	makefile alternative and offers the flexibility of Python.

	$ scons --program=swe_staggered_vector_invariant


	The possible compilation (maybe not complete) options are visible via

	$ scons --help

	The program to be compiled can be specified via -program=...
	with the list of programs given in src/examples


**************************
Compilation on cluster:
**************************

	Please see ./platform/HOWTO