Pypi upload compatible version (#33)

* 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

.github/workflows/tests.yml

@@ -34,7 +34,8 @@ jobs:
         pip install git+https://github.com/MP-Gadget/pfft-python
         pip install git+https://github.com/MP-Gadget/pmesh
         pip install git+https://github.com/ASKabalan/fastpm-python --no-build-isolation
-        pip install .[test]
+        pip install -r requirements-test.txt
+        pip install .
 
     - name: Run Single Device Tests
       run: |

.gitignore

@@ -132,3 +132,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Hide version file
+_version.py

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Differentiable Universe Initiative
+Copyright (c) 2021-2025 Differentiable Universe Initiative
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -0,0 +1,2 @@
+prune notebooks
+prune tests

README.md

@@ -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:

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "wheel", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "JaxPM"
+name = "jaxpm"
 dynamic = ["version"]
 description = "A simple Particle-Mesh implementation in JAX"
 authors = [{ name = "JaxPM developers" }]
@@ -13,19 +13,6 @@ license = { file = "LICENSE" }
 urls = { "Homepage" = "https://github.com/DifferentiableUniverseInitiative/JaxPM" }
 dependencies = ["jax_cosmo", "jax>=0.4.30", "jaxdecomp>=0.2.2"]
 
-[project.optional-dependencies]
-test = [
-    "jax>=0.4.30",
-    "numpy",
-    "jax_cosmo",
-    "jaxdecomp>=0.2.2",
-    "pytest>=8.0.0",
-    "pfft-python @ git+https://github.com/MP-Gadget/pfft-python",
-    "pmesh @ git+https://github.com/MP-Gadget/pmesh",
-    "fastpm @ git+https://github.com/ASKabalan/fastpm-python",
-    "diffrax"
-]
-
 [tool.setuptools]
 packages = ["jaxpm"]
 

requirements-test.txt

@@ -0,0 +1,5 @@
+pytest>=8.0.0
+diffrax
+pfft-python @ git+https://github.com/MP-Gadget/pfft-python
+pmesh @ git+https://github.com/MP-Gadget/pmesh
+fastpm @ git+https://github.com/ASKabalan/fastpm-python