guilhem_lavaux/JaxPM
0
0
Fork 1
mirror of https://github.com/DifferentiableUniverseInitiative/JaxPM.git synced 2025-04-07 04:10:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
JAX-powered Cosmological Particle-Mesh N-body Solver
182 commits 7 branches 5 tags 164 MiB
Jupyter Notebook 99.6%
Python 0.4%
Find a file
Wassim Kabalan af29c4005d Format
2024-12-08 22:45:09 +01:00
.github/workflows added github workflow 2024-08-03 00:44:05 +02:00
benchmarks delete old slurms 2024-10-26 22:48:38 +02:00
dev update formatting 2024-07-09 18:02:57 -04:00
jaxpm Format 2024-12-08 22:45:09 +01:00
notebooks Format 2024-12-08 22:45:09 +01:00
tests Format 2024-12-08 22:45:09 +01:00
.all-contributorsrc docs: update .all-contributorsrc [skip ci] 2024-07-19 14:51:26 +00:00
.gitignore Adjust pencil type for frequencies 2024-07-28 13:44:03 +02:00
.pre-commit-config.yaml apply formatting 2024-07-18 12:38:42 +02:00
LICENSE Initial commit 2021-07-16 23:10:42 +02:00
pyproject.toml Upgrade setup.py to pyproject 2024-12-06 18:57:16 +01:00
README.md update readme 2024-10-30 02:01:05 +01:00

README.md

JaxPM

All Contributors

JAX-powered Cosmological Particle-Mesh N-body Solver

Goals

Provide a modern infrastructure to support differentiable PM N-body simulations using JAX:

  • Keep implementation simple and readable, in pure NumPy API
  • Any order forward and backward automatic differentiation
  • Support automated batching using vmap
  • Compatibility with external optimizer libraries like optax
  • Now fully distributable on multi-GPU and multi-node systems using jaxDecomp working with the latex JAX v0.4.35

Open development and use

Current expectations are:

  • This project is and will remain open source, and usable without any restrictions for any purposes
  • Will be a simple publication on The Journal of Open Source Software
  • Everyone is welcome to contribute, and can join the JOSS publication (until it is submitted to the journal).
  • Anyone (including main contributors) can use this code as a framework to build and publish their own applications, with no expectation that they need to extend authorship to all jaxpm developers.

Getting Started

To dive into JaxPM’s capabilities, please explore the notebook section for detailed tutorials and examples on various setups, from single-device simulations to multi-host configurations. You can find the notebooks' README here for a structured guide through each tutorial.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Francois Lanusse
Francois Lanusse
🤔		 Denise Lanzieri
Denise Lanzieri
💻

This project follows the all-contributors specification. Contributions of any kind welcome!