Update README.md

This commit is contained in:
Francois Lanusse 2021-07-17 01:27:40 +02:00 committed by GitHub
parent bddf0a7ffe
commit 9d4a90d99a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -6,12 +6,6 @@ JAX-powered Cosmological Particle-Mesh N-body Solver
**This project is currently in an early design phased. All inputs are welcome on the [design document](https://github.com/DifferentiableUniverseInitiative/JaxPM/blob/main/design.md)**
Current expectations:
- 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.
## Goals
Provide a modern infrastructure to support differentiable PM N-body simulations using JAX:
@ -21,6 +15,14 @@ Provide a modern infrastructure to support differentiable PM N-body simulations
- 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 ✨