Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 4.34 KB

README.rst

File metadata and controls

72 lines (50 loc) · 4.34 KB
Raw

REBOUND - An open-source multi-purpose N-body code

http://img.shields.io/badge/rebound-v2.9.0-green.svg?style=flat

http://img.shields.io/badge/license-GPL-green.svg?style=flat:target:https://github.com/hannorein/rebound/blob/master/LICENSE

http://img.shields.io/travis/hannorein/rebound/master.svg?style=flat:target:https://travis-ci.org/hannorein/rebound/

http://img.shields.io/badge/arXiv-1110.4876-orange.svg?style=flat:target:http://arxiv.org/abs/1110.4876

http://img.shields.io/badge/arXiv-1409.4779-orange.svg?style=flat:target:http://arxiv.org/abs/1409.4779

http://img.shields.io/badge/arXiv-1506.01084-orange.svg?style=flat:target:http://arxiv.org/abs/1506.01084

FEATURES

REBOUND is an N-body integrator, i.e. a software package that can integrate the motion of particles under the influence of gravity. The particles can represent stars, planets, moons, ring or dust particles. REBOUND is very flexible and can be customized to accurately and efficiently solve many problems in astrophysics. An incomplete feature list of REBOUND:

  • Symplectic integrators (WHFast, WH, SEI, LEAPFROG)
  • High accuracy non-symplectic integrator with adaptive timestepping (IAS15)
  • Support for collisional/granular dynamics, various collision detection routines
  • The code is written entirely in C, conforms to the ISO standard C99 and can be used as a thread-safe shared library
  • Easy-to-use Python module, installation in 3 words: pip install rebound
  • Extensive set of example problems in both C and Python
  • Real-time, 3D OpenGL visualization (C version)
  • Parallelized with OpenMP (for shared memory systems)
  • Parallelized with MPI using an essential tree for gravity and collisions (for distributed memory systems)
  • No libraries are needed, use of OpenGL/GLUT for visualization is optional
  • The code is fully open-source and can be downloaded freely from http://github.com/hannorein/rebound
  • No configuration is needed to run any of the example problems. Just type make && ./rebound in the problem directory to run them
  • Comes with standard ASCII or binary output routines
  • Different modules are easily interchangeable at runtime

One minute installation

You can install REBOUND with pip if you want to only use the python version of REBOUND:

pip install rebound

Then, you can run a simple REBOUND simulation such as

import rebound
sim = rebound.Simulation()
sim.add(m=1.0)
sim.add(m=1.0e-3, a=1.0)
sim.integrate(1000.)
sim.status()

If you want to use the C version of REBOUND simply copy and paste this line into your terminal (it won't do anything bad, we promise):

git clone http://github.com/hannorein/rebound && cd rebound/examples/shearing_sheet && make && ./rebound

Documentation

The full documentation with many examples and tutorials can be found at

http://rebound.readthedocs.org

We're alway trying to improve REBOUND and extending the documention is high on our to-do list. If you have trouble installing or using REBOUND, please open an issue on github and we'll try to help as much as we can.

New Version!

Welcome to REBOUND version 2! We made many changes to the code. Most importanly, REBOUND is now thread-safe and does not use global variables anymore. All the variables that were previously global, are now contained in the reb_simulation structure. This has many advantages, for example, you can run separate simulations in parallel from within one process. We also made it possible to choose all modules at runtime (compared to the selection in the Makefile that was used before). This is much more in line with standard UNIX coding practice and does not severely impact performance (it might even help making REBOUND a tiny bit faster). This makes REBOUND a fully functional shared library. We added a prefix to all public functions and struct definitions: reb_.

There are still some features that haven't been fully ported. Most importantly, the MPI parallelization and the SWEEP collision detection routine.

The best way to get and idea of the changes we made is to look at some of the example problems and the new REBOUND documentation. If you have trouble using the new version or find a bug, please submit an issue or a pull request on github.