guilhem_lavaux/JaxPM
0
0
Fork 1
mirror of https://github.com/DifferentiableUniverseInitiative/JaxPM.git synced 2025-05-14 03:51:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Pypi upload compatible version (#33)

Browse source 
* moving test dependencies separately

* adding manifest to remove unecessary files

* updating name of project

* Fixing formatting

* Adding badge for pypi version

* Adding very simple install instructions
This commit is contained in:
Francois Lanusse 2024-12-21 11:47:13 -05:00 • committed by GitHub
parent 160b86eb71
commit f245a1f685
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 24 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,9 +1,18 @@
# JaxPM
[![Tests](https://github.com/DifferentiableUniverseInitiative/JaxPM/actions/workflows/tests.yml/badge.svg)](https://github.com/DifferentiableUniverseInitiative/JaxPM/actions/workflows/tests.yml) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![PyPI version](https://img.shields.io/pypi/v/jaxpm)](https://pypi.org/project/jaxpm/) [![Tests](https://github.com/DifferentiableUniverseInitiative/JaxPM/actions/workflows/tests.yml/badge.svg)](https://github.com/DifferentiableUniverseInitiative/JaxPM/actions/workflows/tests.yml) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
JAX-powered Cosmological Particle-Mesh N-body Solver
## Install
Basic installation can be done using pip:
```bash
pip install jaxpm
```
For more advanced installation for optimized distribution on gpu clusters, please install jaxDecomp first. See instructions [here](https://github.com/DifferentiableUniverseInitiative/jaxDecomp).
## Goals
Provide a modern infrastructure to support differentiable PM N-body simulations using JAX: