update

kazewong · Sep 19, 2023 · 87a12ef · 87a12ef
1 parent e070032
commit 87a12ef
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 6 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -2,15 +2,15 @@
 
 Jim is a set of tools to solve a number of inference problems in the field of gravitational-wave, including single event parameter estimation and population analysis (coming soon!). Jim is written in python, with heavy use of the [JAX](https://github.com/google/jax) and uses [flowMC](https://github.com/kazewong/flowMC) as its sampler. 
 
-Here is the list of 
+!!! warning
+    **Jim is still in development**: As we are refactoring and continuing the development of the code, the API is subject to change. If you have any questions, please feel free to open an issue.
 
 
 
-
-<a href="https://colab.research.google.com/drive/1ah_mwVpn3A32jhctA6BTj-Nqk7SGf9Dj?usp=sharing">
-<img src="https://img.shields.io/badge/open_in_colab-GW150914-orange?logo=googlecolab" alt="doc"/>
-</a>
-
 ## Design philosophy
 
 1. Extensibility over "feature complete"
+2. Performance is a feature, lacking performance is a bug
+3. We do not do use-case optimization
+
+#
diff --git a/docs/tutorials/anatomy_of_jim.md b/docs/tutorials/anatomy_of_jim.md
@@ -0,0 +1,14 @@
+# Anatomy of Jim
+
+
+
+## Likelihood
+
+### Data
+### Model
+
+## Prior
+
+## Sampler
+
+## Analysis
diff --git a/docs/tutorials/single_event_PE.md b/docs/tutorials/single_event_PE.md
@@ -0,0 +1,6 @@
+# Single event Parameter Estimation
+
+<a href="https://colab.research.google.com/drive/1ah_mwVpn3A32jhctA6BTj-Nqk7SGf9Dj?usp=sharing">
+<img src="https://img.shields.io/badge/open_in_colab-GW150914-orange?logo=googlecolab" alt="doc"/>
+</a>
+
diff --git a/docs/tutorials/single_event_pe.md b/docs/tutorials/single_event_pe.md