update doc

README.md

@@ -1,5 +1,9 @@
 # Jim <img src="https://user-images.githubusercontent.com/4642979/218163532-1c8a58e5-6f36-42de-96d3-f245eee93cf8.png" alt="jim" width="35"/> - A JAX-based gravitational-wave inference toolkit
 
+<a href="https://flowmc.readthedocs.io/en/main/">
+<img src="https://badgen.net/badge/Read/the doc/blue" alt="doc"/>
+</a>
+
 Jim comprises a set of tools for estimating parameters of gravitational-wave sources thorugh Bayesian inference.
 At its core, Jim relies on the JAX-based sampler [flowMC](https://github.com/kazewong/flowMC),
 which leverages normalizing flows to enhance the convergence of a gradient-based MCMC sampler.
@@ -24,7 +28,7 @@ pip install git+https://github.com/kazewong/jim
 
 If you would like to take advantage of CUDA, you will additionally need to install a specific version of JAX by doing
 ```
-pip install --upgrade "jax[cuda]"==0.4.1 -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
+pip install --upgrade "jax[cuda12_pip]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
 ```
 
 _NOTE:_ Jim is only currently compatible with Python 3.10.

docs/gotchas.md

@@ -0,0 +1,3 @@
+## Quality assessment
+## Tuning guide
+## Jax

docs/index.md

@@ -1,17 +1 @@
-# Welcome to MkDocs
-
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+# Jim <img src="https://user-images.githubusercontent.com/4642979/218163532-1c8a58e5-6f36-42de-96d3-f245eee93cf8.png" alt="jim" width="35"/> - A JAX-based gravitational-wave inference toolkit

mkdocs.yml

@@ -74,7 +74,6 @@ plugins:
 nav:
     - Home: index.md
     - Gotchas: gotchas.md
-    - Jax: jax.md
     - Tutorial: tutorials/
     - Examples: examples/
     - API: reference/

readthedocs.yml

@@ -1,27 +1,13 @@
-# Read the Docs configuration file for MkDocs projects
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
 
-# Set the version of Python and other tools you might need
+python:
+  install:
+    - requirements: docs/requirements.txt
+
 build:
   os: ubuntu-22.04
   tools:
-    python:
-      version:
-      - "3.9"
-      - "3.10"
-      - "3.11"
+    python: "3.11"
 
 mkdocs:
-  configuration: mkdocs.yml
-
-# Optionally declare the Python requirements required to build your docs
-python:
-  version:
-  - "3.9"
-  - "3.10"
-  - "3.11"
-  install:
-  - requirements: docs/requirements.txt
+  configuration: mkdocs.yml