Merge pull request #318 from Ciela-Institute/dev

Dev
Ciela-Institute · Jan 26, 2025 · ddc2e09 · ddc2e09
2 parents 30b2df6 + da63032
commit ddc2e09
Show file tree

Hide file tree

Showing 7 changed files with 950 additions and 14 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,8 @@
 exclude: |
   (?x)^(
     tests/utils/
+    |
+    dev_notes/
   )
 
 ci:
@@ -12,6 +14,7 @@ repos:
     rev: "24.10.0"
     hooks:
       - id: black-jupyter
+        exclude: dev_notes/
 
   - repo: https://github.com/asottile/blacken-docs
     rev: "1.19.1"

diff --git a/dev_notes/compareTNFW.ipynb b/dev_notes/compareTNFW.ipynb
diff --git a/docs/source/_config.yml b/docs/source/_config.yml
@@ -31,9 +31,9 @@ repository:
 # Add GitHub buttons to your book
 # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
 html:
-  favicon: ../../media/caustics_favicon.ico
-  use_issues_button: true
   use_repository_button: true
+  use_issues_button: true
+  favicon: ../../media/caustics_favicon.ico
 
 sphinx:
   extra_extensions:

diff --git a/docs/source/_toc.yml b/docs/source/_toc.yml
@@ -10,18 +10,19 @@ chapters:
   - file: gravlensingintro
   - file: tutorials/index
     sections:
-      - file: tutorials/Introduction
       - file: interfaceindex
         sections:
           - file: tutorials/InterfaceIntroduction_yaml
           - file: tutorials/InterfaceIntroduction_oop
           - file: tutorials/InterfaceIntroduction_func
-      - file: tutorials/LensZoo
+      - file: tutorials/BasicCustomSimulator
+      - file: tutorials/IntroductionInDepth
       - file: tutorials/Microlensing
       - file: tutorials/VisualizeCaustics
       - file: tutorials/MultiplaneDemo
       - file: tutorials/InvertLensEquation
       - file: tutorials/MultiSource
+      - file: tutorials/LensZoo
   - file: examples/index
     sections:
       - file: examples/Example_ImageFit_LM

diff --git a/docs/source/intro.md b/docs/source/intro.md
@@ -1,13 +1,11 @@
 # Welcome to Caustics’ documentation!
 
-![Logo GIF](../../media/caustics_logo.gif)
+[![Logo GIF](../../media/caustics_logo.gif)](https://github.com/Ciela-Institute/caustics)
 
 The lensing pipeline of the future: GPU-accelerated,
-automatically-differentiable, highly modular and extensible.
-
-```{note}
-Caustics is in its early development phase. This means the API will change with time. These changes are a good thing, but they can be annoying. Watch the version numbers, when we get to 1.0.0 that will be the first stable release!
-```
+automatically-differentiable, highly modular and extensible. All code is
+installable with `pip` and hosted on
+[GitHub](https://github.com/Ciela-Institute/caustics).
 
 ## Installation