From bddf0a7ffe73430db9617cdaadf3b5a0872a5f0f Mon Sep 17 00:00:00 2001 From: Francois Lanusse Date: Sat, 17 Jul 2021 01:27:06 +0200 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 88f2c5b..e21f6a0 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,22 @@ 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) +**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: +- 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` ## Contributors ✨