Skip to content

Commit

Permalink
minor
Browse files Browse the repository at this point in the history
  • Loading branch information
hannorein committed May 4, 2021
1 parent 292e919 commit ed6fcbc
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/addingparticles.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Adding particles
Once you've created a [simulation object](simulation.md), you can add particles to it.
REBOUND supports several different ways to do that.
Also check out the [discussion on manipulating particles](manipulations.md).
Also check out the [discussion on particle operators](particleoperators.md).

## Adding particles manually
One way to add a particle to a simulation is to first manually create a particle object, then calling a function to add the particle to the simulation.
Expand Down
2 changes: 1 addition & 1 deletion docs/chaos.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Then, initialize the variational particles and MEGNO variables with
REBOUND uses random numbers to initialize the variational particles.
The initial seed is chosen based on the current time and the process id.
This ensures the seed if different every time you run the simulation.
See the discussion on [random sampling](randomsampling.md) for more details.
See the discussion on [random sampling](c_randomsamplingfunctions.md) for more details.

If you want to have reproducible result, you can specify the seed manually:
=== "C"
Expand Down
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,18 @@ There are several papers describing the functionality of REBOUND.

## Acknowledgments

If you use this code or parts of this code for results presented in a scientific publication, please send us a copy of your paper so that we can keep track of all publications that made use of the code. We would greatly appreciate a citation as well. The simplest way to find the citations relevant to the specific setup of your REBOUND simulation is:
If you use this code or parts of this code for results presented in a scientific publication, we would greatly appreciate a citation.
please cite REBOUND.
The simplest way to find the citations relevant to the specific setup of your REBOUND simulation is:

```python
sim = rebound.Simulation()
-your setup-
sim.cite()
```

!!! Info
When you cite one of the REBOUND papers, your paper will receive an automatic shout-out from the [REBOUND Citation Bot](https://twitter.com/reboundbot).

## License

Expand Down
9 changes: 8 additions & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,5 +141,12 @@ into a terminal window while you're in the `examples/simplest/` directory. Then
```

## Where to go from here
To learn more about how to use REBOUND with C, have a look at the examples in the `examples/` directory. You might also want to have a look at the `rebound.h` file in the `src/` directory which contains the API specifications. Last but not least, REBOUND is open source. If you want to know how something works, you can just look at the source code. And of course, you are welcome to [open an issue](https://github.com/hannorein/rebound/issues) on Github or e-mail any of the [contributors](/#contributors) with questions. We'll do our best to answer them quickly.
In addition to reading the remaining sections in the documentation, you can learn most about REBOUND by looking at some of the [example problems](examples.md).
The C examples are located in the `examples/` directory.
The python and iPython examples are located in the `python_examples/` and `ipython_examples/` directories respectively.

You might also want to have a look at the `rebound.h` file in the `src/` directory which contains the precise function prototypes and structure definitions.

If you run into a problem or can't find an answer in this documentation, [open an issue](https://github.com/hannorein/rebound/issues) on Github or e-mail one of the [contributors](/#contributors).
We'll do our best to help you quickly.

0 comments on commit ed6fcbc

Please sign in to comment.