JaxPM_highres/README.md

# JaxPM
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) [![Join the chat at https://gitter.im/DifferentiableUniverseInitiative/JaxPM](https://badges.gitter.im/DifferentiableUniverseInitiative/JaxPM.svg)](https://gitter.im/DifferentiableUniverseInitiative/JaxPM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
JAX-powered Cosmological Particle-Mesh N-body Solver

**This project is currently in an early design phase. All inputs are welcome on the [design document](https://github.com/DifferentiableUniverseInitiative/JaxPM/blob/main/design.md)**

## Goals

Provide a modern infrastructure to support differentiable PM N-body simulations using JAX:
- Keep implementation simple and readable, in pure NumPy API
- Transparent distribution using builtin `xmap`
- Any order forward and backward automatic differentiation
- Support automated batching using `vmap`
- Compatibility with external optimizer libraries like `optax`

## 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](https://joss.theoj.org/)
- 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.


## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="http://flanusse.net"><img src="https://avatars.githubusercontent.com/u/861591?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Francois Lanusse</b></sub></a><br /><a href="#ideas-EiffL" title="Ideas, Planning, & Feedback">🤔</a></td>
  </tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Initial commit 2021-07-16 23:10:42 +02:00			`# JaxPM`
docs: update README.md [skip ci] 2021-07-16 23:08:06 +00:00			`<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->`
Add Gitter badge 2021-08-26 22:38:06 +00:00			`[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) [![Join the chat at https://gitter.im/DifferentiableUniverseInitiative/JaxPM](https://badges.gitter.im/DifferentiableUniverseInitiative/JaxPM.svg)](https://gitter.im/DifferentiableUniverseInitiative/JaxPM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
docs: update README.md [skip ci] 2021-07-16 23:08:06 +00:00			`<!-- ALL-CONTRIBUTORS-BADGE:END -->`
Initial commit 2021-07-16 23:10:42 +02:00			`JAX-powered Cosmological Particle-Mesh N-body Solver`
Update README.md 2021-07-17 00:31:44 +02:00
Update README.md 2022-02-14 11:56:27 +01:00			`This project is currently in an early design phase. All inputs are welcome on the [design document](https://github.com/DifferentiableUniverseInitiative/JaxPM/blob/main/design.md)`
Update README.md 2021-07-17 01:27:06 +02:00
			`## Goals`

			`Provide a modern infrastructure to support differentiable PM N-body simulations using JAX:`
			`- Keep implementation simple and readable, in pure NumPy API`
			- Transparent distribution using builtin `xmap`
			`- Any order forward and backward automatic differentiation`
			- Support automated batching using `vmap`
			- Compatibility with external optimizer libraries like `optax`
Update README.md 2021-07-17 00:31:44 +02:00
Update README.md 2021-07-17 01:27:40 +02:00			`## 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](https://joss.theoj.org/)`
			`- 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.`

docs: update README.md [skip ci] 2021-07-16 23:08:06 +00:00
			`## Contributors ✨`

			`Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):`

			`<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->`
			`<!-- prettier-ignore-start -->`
			`<!-- markdownlint-disable -->`
			`<table>`
			`<tr>`
Merge branch 'main' into all-contributors/add-EiffL 2021-07-17 01:14:06 +02:00			`<td align="center"><a href="http://flanusse.net"><img src="https://avatars.githubusercontent.com/u/861591?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Francois Lanusse</b></sub></a><br /><a href="#ideas-EiffL" title="Ideas, Planning, & Feedback">🤔</a></td>`
docs: update README.md [skip ci] 2021-07-16 23:08:06 +00:00			`</tr>`
			`</table>`

			`<!-- markdownlint-restore -->`
			`<!-- prettier-ignore-end -->`

			`<!-- ALL-CONTRIBUTORS-LIST:END -->`

Update README.md 2021-07-17 01:11:08 +02:00			`This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!`