Skip to content

Open-source SPH and N-body code written in C/C++

License

Notifications You must be signed in to change notification settings

Zi7ar21/starflood

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Starflood

Starflood is a free and open-source SPH N-body code written in C/C++.

Features

  • Semi-simultaneous simulation and rendering
  • Decently optimized low-level C/C++ code with high-level parallelism via OpenMP
  • Performance profiling using omp_get_wtime for double-precision timing (a little less precision than a nanosecond after 6 months uptime)
  • Particle-Particle Gravity Solver O(N²)

Planned

Installation

At this point in time, Starflood doesn't have a method of installion. It's up to you to manually choose where you want the repository and build it.

Cloning the Repository

First, navigate to the folder you like to keep your repositories in. For example, I like to keep mine in ~/source.

cd <folder you want the starflood repo in>

Next, clone this repository.

git clone https://github.com/Zi7ar21/starflood.git

Next, enter the repository

cd starflood

Building Starforge

Starforge uses CMake. Outlined below are some steps to build the project in a folder inside the repository. <starforge repository>/build is a part of the .gitignore, so no need to worry about accidentally commiting all your binaries.

First, create a folder to build Starforge in.

mkdir build

Then enter the newly created build directory.

cd build

Then, run cmake to configure the Starforge project.

cmake ..

This next part is platform-dependent, but by default on most major Linux distributions CMake will create a Makefile so you can build the project simply by running make.

make

Congratulations! You (should) have just successfully compiled Starflood.

Running

Starforge can be executed simply by running the compiled executable. Again, this may vary depending on the platform but on most major Linux distributions you can simply run Starflood.

./Starflood

If this does not work, your compiler may not have set the execute bit. This can be done by running chmod +x ./Starflood. If your sysadmin sucks, you may need to run this as a privilaged user (sudo chmod +x ./Starflood, doas chmod +x ./Starflood, or your system's equivalent). I think I have ran into this issue once, but it really shouldn't be an issue on most major Linux distributions.

On Windows the compiled binary probably has .exe appended to it.

Starflood.exe

About

Open-source SPH and N-body code written in C/C++

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published