Skip to content

Commit

Permalink
Add beginnings of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewcarbone committed Dec 18, 2023
1 parent cb6d7ae commit 7f3bd00
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ _If you use this code, please consider citing our [work](https://doi.org/10.1103

[MPI load-balancer](https://github.com/matthewcarbone/hdspin/blob/master/src/main_utils.cpp), allowing for massively parallel simulations on high-performance computing systems. The rare time-consuming job no longer holds up other simulations.

# ⭐️ Documentation

TK

# 📕 Installation instructions

hdspin requires [MPI](http://www.mpi-forum.org), and is tested using [MPICH](https://www.mpich.org) and [Open MPI](https://www.open-mpi.org) on both Ubuntu latest and MacOS. Other than that, every external dependency is self-contained explicitly under the terms of their licences. Installing hdspin should be straightforward using CMake:
Expand Down
15 changes: 15 additions & 0 deletions docs/observables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Observables

We outline the various observables that hdspin calculates.

- Statistics are not saved at every timestep. As it is possible to have many millions of timesteps, this is not tractable from a storage standpoint. Grids are generally linear in log-space, and observables are saved only at those timesteps.
- Most observables have a variety of statistics saved, including the mean, standard deviation, standard error, and median (at every timestep on the grid).
- All averaged statistics can be found in the `results.json` file saved at the end of the simulation.

## Average energy

Consider the energy of tracer $i$ at simulation clock time $t$ is $E_{i}(t).$ The average energy over $N$ tracers is simply given by

$$ E(t) = \frac{1}{N} \sum_{i=1}^N E_i(t).$$

Results for the energy can be accessed via `results["energy"]`.

0 comments on commit 7f3bd00

Please sign in to comment.