update docs

Fanchengyan · Jan 23, 2024 · ba472a9 · ba472a9
1 parent 9f12ee4
commit ba472a9
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 30 deletions.
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -3,6 +3,8 @@ Python API Reference
 
 
 .. toctree::
+   :maxdepth: 2
+   :caption: Contents:
 
    datasets/datasets
    query/query

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -6,9 +6,9 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "FanSAR"
-copyright = "2023, Fancy"
-author = "Fancy"
+project = "FanInSAR"
+copyright = "2023, Fan Chengyan (Fancy)"
+author = "Fan Chengyan (Fancy)"
 release = "v1.0"
 
 # -- General configuration ---------------------------------------------------
@@ -37,10 +37,6 @@
 html_theme = "sphinx_rtd_theme"
 # html_static_path = ['_static']
 
-# General information about the project.
-project = "faninsar"
-copyright = "2023, Fancy"
-author = "Chengyan Fan"
 
 video_enforce_extra_source = True
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -2,15 +2,26 @@
 Welcome to FanInSAR's documentation!
 ====================================
 
+.. image:: https://readthedocs.org/projects/faninsar/badge/?version=latest
+    :target: https://faninsar.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
 
 Introduction
 ------------
+FanInSAR is a fancy InSAR processing library written in Python. It is designed to help you process InSAR data in a pythonic, fast, and flexible way. If you want to implement your InSAR algorithm, FanInSAR is a highly recommended choice.
+
+Highlight Features
+------------------
+
+- **Fast**: The heavy computation core in FanInSAR is written in ``Pytorch``, a high-performance deep learning library. You can easily run FanInSAR on GPU to speed up the processing.
+- **Pythonic**: FanInSAR is written in Python, and the API is designed to be simple and intuitive. We design the class structure to be high-level and easy to use for the InSAR user. For example, you can easily load the ``HyP3`` product and process it with a few lines of code. 
+- **Flexible**: FanInSAR is designed to be flexible. You can easily inherit the class or customize the processing pipeline to meet your needs. 
+
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 3
    :caption: Contents:
 
-   intro
    install
    User Guide <user_guide/index>
    FanInSAR API Reference <api/index>

diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -14,11 +14,11 @@ or from GitHub:
     pip install git+https://github.com/Fanchengyan/FanInSAR.git
 
 
-Optional dependencies
----------------------
+.. Optional dependencies
+.. ---------------------
 
-The following dependencies are optional:
+.. The following dependencies are optional:
 
-- isce3: for reading and writing ISCE products (TODO)
-- zarr: for reading and writing Zarr products (TODO)
+.. - isce3: for reading and writing ISCE products (TODO)
+.. - zarr: for reading and writing Zarr products (TODO)
 
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
diff --git a/docs/source/terminology.rst b/docs/source/terminology.rst
@@ -24,7 +24,6 @@ Terminology
 
     Loop
         A loop contains a list of edge pairs and one diagonal pair. See paper [1]_ for more details.
-        TODO: add paper reference.
 
     Loops
         A collection of loops.
@@ -39,4 +38,10 @@ Terminology
         A collection of loops and pairs.
 
     CRS
-        A coordinate reference system (CRS) is a coordinate-based local, regional or global system used to locate geographical entities. In FanInSAR, the CRS is handled by the ``rasterio`` package.
+        A coordinate reference system (CRS) is a coordinate-based local, regional or global system used to locate geographical entities. In FanInSAR, the CRS is handled by the ``rasterio`` package.
+
+.. [1] : Fan, Chengyan, Cuicui Mu, Lin Liu, and Zhuoyi Zhao. “Does InSAR Time Series Using C-Band Sentinel-1 Data Underestimate Surface Deformation Over Permafrost Regions on Qinghai-Tibetan Plateau?,”.
+
+
+
+
diff --git a/docs/source/user_guide/data_structures.rst b/docs/source/user_guide/data_structures.rst
@@ -1,4 +1,2 @@
-.. _data structures:
-
 Data Structures
 ===============
diff --git a/docs/source/user_guide/index.rst b/docs/source/user_guide/index.rst
@@ -10,6 +10,7 @@ examples that describe many common tasks that you can accomplish with FanSAR.
    :maxdepth: 2
    :hidden:
 
+   quick_start
    data_structures
    Indexing_data
 

diff --git a/docs/source/user_guide/quick_start.rst b/docs/source/user_guide/quick_start.rst
@@ -0,0 +1,5 @@
+Quick Start
+===========
+
+This guide will help you get started with basic usage of the FanInSAR library.
+