release info

Author: astanziola

.gitignore

@@ -9,6 +9,10 @@
 htmlcov
 .coverage
 
+# Build 
+build
+dist
+
 # Paper images
 docs/notebooks/img/*.png
 

README.md

@@ -73,17 +73,12 @@ gradient = grad(loss)(u_fourier_params)
 
 Before installing `jaxdf`, make sure that [you have installed JAX](https://github.com/google/jax#installation). Follow the instruction to install JAX with NVidia GPU support if you want to use `jaxdf` on the GPUs. 
 
-Install jaxdf by `cd` in the repo folder an run
+Install jaxdf by cloning the repository or downloading and extracting the compressed archive. Then navigate in the root folder in a terminal, and run
 ```bash
 pip install -r requirements.txt
 pip install .
 ```
 
-If you want to run the notebooks, you should also install the following packages
-```bash
-pip install jupyterlab, tqdm
-```
-
 <br/>
 
 ## Citation

jaxdf/__init__.py

@@ -0,0 +1,9 @@
+from core import *
+import discretization
+import geometry
+import ode
+import operators
+import primitives
+import spectral
+import utils
+import version

jaxdf/version.py

@@ -1 +1,2 @@
 __version__ = "0.1.0"
+__status ="Development Status :: 2 - Alpha"

setup.py

@@ -5,6 +5,7 @@
 with open("jaxdf/version.py") as f:
     exec(f.read(), _dct)
 __version__ = _dct["__version__"]
+__status = _dct["__status"]
 
 setup(
     name="jaxdf",
@@ -19,9 +20,15 @@
     extras_require={
         "dev": open("_setup/dev_requirements.txt", "r").readlines(),
     },
-    url="https://bug.medphys.ucl.ac.uk/",
+    url="https://github.com/ucl-bug/jaxdf",
     license="GNU Lesser General Public License (LGPL)",
+    keywords=[
+        "jax","pde","discretization","differential-equation",
+        "simulation", "differentiable-programming"],
     classifiers=[
+        "Intended Audience :: Education",
+        "Intended Audience :: Science/Research",
+        __status,
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9"