Skip to content

Commit 74e2e71

Browse files
committed
update readme
1 parent 9713103 commit 74e2e71

File tree

4 files changed

+21
-5
lines changed

4 files changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,31 +38,47 @@ Author: [Philip Mocz (@pmocz)](https://github.com/pmocz/)
3838

3939
⚠️ Adirondax is currently being built and is not yet ready for use. Check back later ⚠️
4040

41-
Adirondax is a scientific research software for conducting astrophysical and cosmological simulations and solving inverse problems. It is written in JAX and GPU-ready.
41+
Adirondax is a high-performance scientific research software for conducting astrophysical and cosmological simulations. Being differentiable, Adirondax can seamlessly integrate with pipelines for inverse-problems, inference, optimization, and coupling to ML models. Adirondax is scalable on multiple GPUs.
4242

4343
Adirondax has a simpler companion project dedicated to Fuzzy Dark Matter simulations: [Jaxion](https://github.com/JaxionProject/jaxion)
4444

4545

46-
## Getting started
46+
## Install Adirondax
4747

4848
Install with
4949

5050
```console
5151
pip install adirondax
5252
```
5353

54+
See the docs for more info on how to [build from source](https://adirondax.readthedocs.io/en/latest/pages/installation.html).
55+
5456

5557
## Examples
5658

57-
Check out the `examples/` directory for demonstrations of using Adirondax.
59+
Check out the [`examples/`](https://github.com/Adirondax/adirondax/tree/main/examples/) directory for demonstrations of using Adirondax.
5860

61+
<p align="center">
62+
<a href="https://github.com/Adirondax/adirondax/tree/main/examples/kelvin_helmholtz">
63+
<img src="examples/kelvin_helmholtz/movie.gif" alt="kelvin_helmholtz" width="128"/>
64+
</a>
65+
<a href="https://github.com/Adirondax/adirondax/tree/main/examples/logo_inverse_problem">
66+
<img src="examples/logo_inverse_problem/movie.gif" alt="logo_inverse_problem" width="128"/>
67+
</a>
68+
<a href="https://github.com/Adirondax/adirondax/tree/main/examples/orszag_tang">
69+
<img src="examples/orszag_tang/movie.gif" alt="orszag_tang" width="128"/>
70+
</a>
71+
<br>
72+
</p>
5973

6074
## Links
6175

6276
* [Code repository](https://github.com/AdirondaxProject/adirondax) on GitHub (this page).
63-
* [Documentation](https://adirondax.readthedocs.io) for up-to-date information about installing and running adirondax.
64-
* [asv benchmarks](https://adirondaxproject.github.io/adirondax-benchmarks) to view timing of benchmark test problems (for Developers).
77+
* [Documentation](https://adirondax.readthedocs.io) for up-to-date information about installing and using Adirondax.
78+
* [asv benchmarks](https://adirondaxproject.github.io/adirondax-benchmarks) to view code timing and memory benchmarks (for Developers).
6579

6680

6781
## Cite this repository
6882

83+
If you use this software, please cite it as below.
84+

0 commit comments

Comments
 (0)