Skip to content

Commit 130c009

Browse files
pmoczpmocz
committed
update docs
1 parent 74e2e71 commit 130c009

File tree

10 files changed

+378
-8
lines changed

10 files changed

+378
-8
lines changed

‎docs/index.rst‎

Lines changed: 108 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,117 @@
11
adirondax
22
=========
33

4-
Adirondax is a scientific research software for conducting astrophysical and cosmological simulations and solving inverse problems.
5-
It is written in JAX and GPU-ready.
4+
.. grid:: 1
5+
:class-container: color-cards
6+
7+
.. grid-item-card:: Differentiable Astrophysics
8+
:columns: 12 12 12 12
9+
:class-card: adirondax-summary
10+
11+
.. image:: _static/adirondax.png
12+
:alt: Adirondax logo
13+
:width: 96px
14+
:align: left
15+
16+
**Adirondax** is a scientific research software for conducting astrophysical and cosmological simulations and solving inverse problems, implemented in JAX and utilizing automatic differentiation and multi-GPU acceleration.
617

718
⚠️ Adirondax is currently being built and is not yet ready for use. Check back later! ⚠️
819

9-
.. automodule:: adirondax.simulation
10-
:members:
20+
21+
.. grid:: 3
22+
:class-container: product-offerings
23+
:margin: 0
24+
:padding: 0
25+
:gutter: 0
26+
27+
.. grid-item-card:: Differentiable Physics
28+
:columns: 12 6 6 4
29+
:class-card: sd-border-0
30+
:shadow: None
31+
32+
Solvers in Adirondax are fully differentiable, enabling gradient-based inference, parameter optimization, and coupling to ML models directly through the simulation.
33+
34+
.. grid-item-card:: Scalable Performance
35+
:columns: 12 6 6 4
36+
:class-card: sd-border-0
37+
:shadow: None
38+
39+
Built with JAX, Adirondax scales on multiple GPUs/TPUs, allowing large-scale simulations to run efficiently on modern accelerators.
40+
41+
.. grid-item-card:: Modular & Composable
42+
:columns: 12 6 6 4
43+
:class-card: sd-border-0
44+
:shadow: None
45+
46+
Adirondax physics modules and processing tools are composable, making it easy to extend or embed into larger workflows.
47+
48+
49+
.. grid:: 3
50+
:class-container: color-cards
51+
52+
.. grid-item-card:: :material-regular:`laptop_chromebook;2em` Installation
53+
:columns: 12 6 6 4
54+
:link: pages/installation
55+
:link-type: doc
56+
:class-card: installation
57+
58+
.. grid-item-card:: :material-regular:`rocket_launch;2em` Quickstart
59+
:columns: 12 6 6 4
60+
:link: pages/quickstart
61+
:link-type: doc
62+
:class-card: quickstart
63+
64+
.. grid-item-card:: :material-regular:`library_books;2em` Examples
65+
:columns: 12 6 6 4
66+
:link: pages/examples
67+
:link-type: doc
68+
:class-card: examples
69+
70+
71+
72+
.. list-table::
73+
:widths: 32 32 32
74+
:header-rows: 0
75+
76+
* - .. figure:: ../examples/kelvin_helmholtz/movie.gif
77+
:width: 300px
78+
:align: center
79+
:alt: kelvin_helmholtz
80+
:target: pages/examples.html#kelvin-helmholtz
81+
82+
- .. figure:: ../examples/logo_inverse_problem/movie.gif
83+
:width: 300px
84+
:align: center
85+
:alt: logo_inverse_problem
86+
:target: pages/examples.html#logo-inverse-problem
87+
88+
- .. figure:: ../examples/orszag_tang/movie.gif
89+
:width: 300px
90+
:align: center
91+
:alt: orszag_tang
92+
:target: pages/examples.html#orszag-tang
93+
94+
95+
.. toctree::
96+
:maxdepth: 1
97+
:caption: Getting Started
98+
99+
pages/installation
100+
pages/quickstart
101+
102+
.. toctree::
103+
:maxdepth: 1
104+
:caption: Tutorials & Examples
105+
106+
pages/examples
11107

12108
.. toctree::
13-
:maxdepth: 2
14-
:caption: Contents:
109+
:maxdepth: 1
110+
:caption: References
15111

16-
pages/installation
112+
pages/parameters
113+
pages/equations
114+
pages/api
115+
pages/developing
116+
pages/citing
117+
pages/about

‎docs/pages/about.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
About
2+
=====
3+
4+
Adirondax is a high-performance astrophysics simulation research code in Python/JAX, with automatic differentiation and GPU/TPU acceleration.
5+
6+
The code is open-source and available at:
7+
8+
https://github.com/AdirondaxProject/adirondax
9+
10+
The documentation is hosted at:
11+
12+
https://adirondax.readthedocs.io
13+
14+
The code is developed by `Philip Mocz <https://pmocz.github.io/>`_, launched in 2025.
15+
16+
Community contributions are welcome! Check out `Developing <../pages/developing.html>`_ for guidelines.
17+
18+
Please cite the work if you use Adirondax in your research; see: `Citing <../pages/citing.html>`_.

‎docs/pages/api.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Adirondax API
2+
=============
3+
4+
simulation
5+
----------
6+
7+
.. automodule:: adirondax.simulation
8+
:members:
9+
10+
11+
constants
12+
---------
13+
14+
.. automodule:: adirondax.constants
15+
:no-index:
16+
17+
.. autoclass:: adirondax.constants
18+
19+
20+
visualization
21+
-------------
22+
23+
TODO
24+
25+
26+
analysis
27+
--------
28+
29+
TODO

‎docs/pages/citing.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Citing
2+
======
3+
4+
If you use this software, please cite it as below.
5+
6+
TODO

‎docs/pages/developing.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Developing
2+
==========
3+
4+
Community contributions to Adirondax are welcome!
5+
6+
Start by forking the repository on `GitHub <https://github.com/AdirondaxProject/adirondax>`_, creating a new branch, and making a pull request with your changes.
7+
8+
Check out the `CONTRIBUTING <https://github.com/AdirondaxProject/adirondax/blob/main/CONTRIBUTING.md>`_ guidelines.
9+
10+
Code changes should pass testing (each commit is automatically tested with GitHub Actions).
11+
Tests can be run locally in the project directory with ``pytest``:
12+
13+
.. code-block:: bash
14+
15+
pytest
16+
17+
Tests are located in the ``tests/`` directory. New features should include appropriate tests.

‎docs/pages/equations.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Equations
2+
=========
3+
4+
Adirondax solves the following equations:
5+
6+
7+
Magnetohydrodynamics
8+
--------------------
9+
10+
TODO
11+
12+
Schrodinger-Poisson
13+
-------------------
14+
15+
TODO
16+

‎docs/pages/examples.rst‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
Examples
2+
========
3+
4+
The `examples/ <https://github.com/AdirondaxProject/adirondax/tree/main/examples>`_ directory contains a collection of astrophysics simulations demonstrating various applications of the Adirondax library.
5+
6+
7+
Gallery
8+
-------
9+
10+
.. list-table::
11+
:widths: 32 32 32
12+
:header-rows: 0
13+
14+
* - .. figure:: ../../examples/kelvin_helmholtz/movie.gif
15+
:width: 300px
16+
:align: center
17+
:alt: kelvin_helmholtz
18+
:target: examples.html#kelvin-helmholtz
19+
20+
- .. figure:: ../../examples/logo_inverse_problem/movie.gif
21+
:width: 300px
22+
:align: center
23+
:alt: logo_inverse_problem
24+
:target: examples.html#logo-inverse-problem
25+
26+
- .. figure:: ../../examples/orszag_tang/movie.gif
27+
:width: 300px
28+
:align: center
29+
:alt: orszag_tang
30+
:target: examples.html#orszag-tang
31+
32+
33+
kelvin_helmholtz
34+
----------------
35+
36+
.. figure:: ../../examples/kelvin_helmholtz/movie.gif
37+
:width: 300px
38+
:align: center
39+
:alt: kelvin_helmholtz
40+
:target: examples.html#kelvin-helmholtz
41+
42+
See on GitHub: `examples/kelvin_helmholtz <https://github.com/AdirondaxProject/adirondax/tree/main/examples/kelvin_helmholtz>`_
43+
44+
README:
45+
46+
.. literalinclude:: ../../examples/kelvin_helmholtz/README.md
47+
:language: md
48+
49+
Script:
50+
51+
.. literalinclude:: ../../examples/kelvin_helmholtz/kelvin_helmholtz.py
52+
:language: python
53+
54+
55+
logo_inverse_problem
56+
--------------------
57+
58+
.. figure:: ../../examples/logo_inverse_problem/movie.gif
59+
:width: 300px
60+
:align: center
61+
:alt: logo_inverse_problem
62+
:target: examples.html#logo-inverse-problem
63+
64+
See on GitHub: `examples/logo_inverse_problem <https://github.com/AdirondaxProject/adirondax/tree/main/examples/logo_inverse_problem>`_
65+
66+
README:
67+
68+
.. literalinclude:: ../../examples/logo_inverse_problem/README.md
69+
:language: md
70+
71+
Script:
72+
73+
.. literalinclude:: ../../examples/logo_inverse_problem/logo_inverse_problem.py
74+
:language: python
75+
76+
77+
orszag_tang
78+
-----------
79+
80+
.. figure:: ../../examples/orszag_tang/movie.gif
81+
:width: 300px
82+
:align: center
83+
:alt: orszag_tang
84+
:target: examples.html#kelvin-helmholtz
85+
86+
See on GitHub: `examples/orszag_tang <https://github.com/AdirondaxProject/adirondax/tree/main/examples/orszag_tang>`_
87+
88+
README:
89+
90+
.. literalinclude:: ../../examples/orszag_tang/README.md
91+
:language: md
92+
93+
Script:
94+
95+
.. literalinclude:: ../../examples/orszag_tang/orszag_tang.py
96+
:language: python

‎docs/pages/installation.rst‎

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,55 @@
11
Installation
22
============
33

4-
To install the Adirondax package, you can use the following command:
4+
5+
From PyPI
6+
---------
7+
8+
To install the latest release version of the Adirondax package, run the following command:
59

610
.. code-block:: bash
711
812
pip install adirondax
913
14+
For GPU support, use the following command instead:
15+
16+
.. code-block:: bash
17+
18+
pip install adirondax[cuda12]
19+
20+
.. note::
21+
For now, to build with GPU support, use the build from source method below. This will be simplified in future releases.
22+
23+
24+
Build from Source
25+
-----------------
26+
27+
Check out the repository:
28+
29+
.. code-block:: bash
30+
31+
git clone git@github.com:AdirondaxProject/adirondax.git
32+
33+
Navigate to the project directory:
34+
35+
.. code-block:: bash
36+
37+
cd adirondax
38+
39+
Install the package using pip (CPU version):
40+
41+
.. code-block:: bash
42+
43+
pip install .
44+
45+
For GPU support, use the following command instead:
46+
47+
.. code-block:: bash
48+
49+
pip install .[cuda12]
50+
51+
Verify the installation by running the test suite:
52+
53+
.. code-block:: bash
54+
55+
pytest

‎docs/pages/parameters.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Parameters
2+
==========
3+
4+
Adirondax allows the user to configure the simulation via the following set of parameters:
5+
6+
.. literalinclude:: ../../adirondax/defaults.json
7+
:language: json

0 commit comments

Comments
 (0)