Skip to content

Commit 2a43ef6

Browse files
authored
Update examples readmes and add citation (#38)
* Update examples readmes * Add citation
1 parent ccd6b73 commit 2a43ef6

File tree

3 files changed

+34
-2
lines changed

3 files changed

+34
-2
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,14 @@ plt.show()
7676
</p>
7777

7878

79+
# Citation
80+
If you use `thermox` in your research, please cite the library using the following BibTeX entry:
81+
82+
```bibtex
83+
@misc{duffield2024thermox,
84+
title={thermox: Exact OU processes with JAX},
85+
author={Duffield, Samuel and Donatella, Kaelan and Melanson, Denis},
86+
howpublished={\url{https://github.com/normal-computing/thermox}},
87+
year={2024}
88+
}
89+
```

examples/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Examples
22

3-
You will find two Jupyter notebooks in this folder:
3+
You will find three Jupyter notebooks in this folder:
44

5+
- `associative_scan.ipynb` plots the speedup of the associative scan algorithm implemented in `thermox` using a GPU.
56
- `diffrax_comparison.ipynb` runs a simple OU process using `thermox` and [`diffrax`](https://github.com/patrick-kidger/diffrax) and compares runtimes (showing a large benefit from using `thermox` for long simulation times)
6-
- `thermodynamic_linear_algebra.ipynb` is a small tutorial on how to use functions from the `thermox.linalg` module.
7+
- `thermodynamic_linear_algebra.ipynb` is a small tutorial on how to use functions from the `thermox.linalg` module.
8+
9+
Additionally the `matrix_exponentials` folder contains code for reproducing the simulations
10+
in the [thermodynamic matrix exponentials paper](https://arxiv.org/abs/2311.12759).
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Thermodynamic Matrix Exponentials Simulations
2+
3+
This folder contains code to replicate the convergence time simulations in the
4+
[thermodynamic matrix exponentials paper](https://arxiv.org/abs/2311.12759).
5+
6+
The script `run.py` contains the code to run the simulations and can be executed with
7+
e.g. the following command from the root of the repository:
8+
```bash
9+
PYTHONPATH=. python examples/matrix_exponentials/run.py --n_repeats=10 --matrix_type=orthogonal --alpha=1.1
10+
```
11+
where `--matrix_type` represents a function in `matrix_generation.py`.
12+
13+
The script `plot.py` contains the code to plot the results of the simulations and can be executed with e.g. the following command from the root of the repository:
14+
```bash
15+
PYTHONPATH=. python examples/matrix_exponentials/plot.py --save_dir=examples/matrix_exponentials/results_orthogonal.pkl
16+
```
17+

0 commit comments

Comments
 (0)