diff --git a/README.md b/README.md index 1b9d6080..36ccb389 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Jim jim - A JAX-based gravitational-wave inference toolkit + +doc + + 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. diff --git a/docs/gotchas.md b/docs/gotchas.md index e69de29b..a2f1faa2 100644 --- a/docs/gotchas.md +++ b/docs/gotchas.md @@ -0,0 +1,3 @@ +## Quality assessment +## Tuning guide +## Jax \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 000ea345..a2ac8797 100644 --- a/docs/index.md +++ b/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 jim - A JAX-based gravitational-wave inference toolkit \ No newline at end of file diff --git a/docs/jax.md b/docs/jax.md deleted file mode 100644 index e69de29b..00000000 diff --git a/mkdocs.yml b/mkdocs.yml index b44dd4b7..6ece4db8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -74,7 +74,6 @@ plugins: nav: - Home: index.md - Gotchas: gotchas.md - - Jax: jax.md - Tutorial: tutorials/ - Examples: examples/ - API: reference/ diff --git a/readthedocs.yml b/readthedocs.yml index 7ec731f8..e4c2d803 100644 --- a/readthedocs.yml +++ b/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 \ No newline at end of file + configuration: mkdocs.yml \ No newline at end of file