update readthedoc

mr-superonion · Sep 9, 2023 · 6fd7d2e · 6fd7d2e
1 parent 63c7f8f
commit 6fd7d2e
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 56 deletions.
diff --git a/docs/demos.md b/docs/demos.md
diff --git a/docs/fpfs.rst b/docs/fpfs.rst
@@ -1,42 +1,11 @@
-Modules
+FPFS
 ============
 
-fpfs.catalog
--------------------
+.. toctree::
+    :maxdepth: 1
 
-.. automodule:: fpfs.catalog
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-fpfs.image
------------------
-
-.. automodule:: fpfs.image
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-fpfs.imgutil
--------------------
-
-.. automodule:: fpfs.imgutil
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-fpfs.pltutil
--------------------
-
-.. automodule:: fpfs.pltutil
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-fpfs.simutil
--------------------
-
-.. automodule:: fpfs.simutil
-   :members:
-   :undoc-members:
-   :show-inheritance:
+    fpfs_image
+    fpfs_catalog
+    fpfs_imgutil
+    fpfs_simutil
+    fpfs_pltutil
diff --git a/docs/fpfs_catalog.rst b/docs/fpfs_catalog.rst
@@ -0,0 +1,7 @@
+fpfs.catalog
+-------------------
+
+.. automodule:: fpfs.catalog
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/fpfs_image.rst b/docs/fpfs_image.rst
@@ -0,0 +1,7 @@
+fpfs.image
+-----------------
+
+.. automodule:: fpfs.image
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/fpfs_imgutil.rst b/docs/fpfs_imgutil.rst
@@ -0,0 +1,7 @@
+fpfs.imgutil
+-------------------
+
+.. automodule:: fpfs.imgutil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/fpfs_pltutil.rst b/docs/fpfs_pltutil.rst
@@ -0,0 +1,7 @@
+fpfs.pltutil
+-------------------
+
+.. automodule:: fpfs.pltutil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/fpfs_simutil.rst b/docs/fpfs_simutil.rst
@@ -0,0 +1,7 @@
+fpfs.simutil
+-------------------
+
+.. automodule:: fpfs.simutil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,6 +5,16 @@
 
 FPFS: A fast, accurate shear estimator
 ======================================
+Fourier Power Function Shapelets (FPFS) is an innovative estimator for the
+shear responses of galaxy shape, flux, and detection. Utilizing leading-order
+perturbations of shear (a vector perturbation) and image noise (a tensor
+perturbation), FPFS determines shear and noise responses for both measurements
+and detections. Unlike traditional methods that distort each observed galaxy
+repeatedly, FPFS employs analytical shear responses of select basis functions,
+including Shapelets basis and peak basis. Remarkably efficient, FPFS can
+process approximately 1,000 galaxies within a single CPU second. Testing under
+simple simulations has proven its capability to maintain a multiplicative shear
+estimation bias below 0.5%, even amidst blending challenges.
 
 .. toctree::
     :maxdepth: 2
@@ -13,8 +23,6 @@ FPFS: A fast, accurate shear estimator
 
     Examples <examples/README.md>
 
-    Demos <demos.md>
-
     fpfs