Merge pull request #10 from luhipi/ci-docs

Deploy pages

.github/workflows/ci.yml

@@ -2,8 +2,11 @@ name: CI
 
 on: [push, pull_request]
 
+permissions:
+  contents: write
+
 env:
-    SKIP: true
+    SKIP: false
 
 jobs:
   before_script:
@@ -47,6 +50,7 @@ jobs:
           conda init bash
           source ~/.bashrc
           mamba env remove --name ci_temp_env --yes || echo "Environment ci_temp_env does not exist"
+          
           conda create -n ci_temp_env --clone ci_env
           source activate ci_temp_env
           mamba install json5
@@ -197,20 +201,38 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.x'
+
+      - name: Download docs
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: docs/_build/html/
+
+      - name: Download coverage report
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report
+          path: htmlcov/
+
+      - name: Download report.html
+        uses: actions/download-artifact@v4
+        with:
+          name: test-report
 
       - name: Deploy to GitHub Pages
         if: env.SKIP == 'false'
         run: |
           rm -rf public
-          mkdir -p public/doc
+          mkdir -p public/docs
           mkdir -p public/images/
           mkdir -p public/coverage
           mkdir -p public/test_reports
-          cp -r docs/_build/html/* public/doc/
+          
+          cp -r docs/_build/html/* public/docs/
           cp -r htmlcov/* public/coverage/
           cp report.html public/test_reports/
           ls -al public
-          ls -al public/doc
+          ls -al public/docs
           ls -al public/coverage
           ls -al public/test_reports
         shell: bash

README.rst

@@ -10,21 +10,18 @@ Open-source InSAR time series analysis software developed within the project SAR
 Documentation
 -------------
 The documentation with installation instructions, processing steps, and examples with a demo dataset can be found at:
-https://ipi-sar4infra.projektpages.uni-h.de/timeseries/doc/
+https://luhipi.github.io/sarvey/docs/
 
 
 
 Status
 ------
 
-.. image:: https://gitlab.projekt.uni-hannover.de/ipi-sar4infra/timeseries/badges/main/pipeline.svg
-        :target: https://gitlab.projekt.uni-hannover.de/ipi-sar4infra/timeseries/-/pipelines
+.. image:: https://github.com/luhipi/sarvey/actions/workflows/ci.yml/badge.svg
+        :target: https://github.com/luhipi/sarvey/actions
         :alt: Pipelines
-.. image:: https://gitlab.projekt.uni-hannover.de/ipi-sar4infra/timeseries/badges/main/coverage.svg
-        :target: https://ipi-sar4infra.projektpages.uni-h.de/timeseries/coverage/
-        :alt: Coverage
-.. image:: https://img.shields.io/static/v1?label=Documentation&message=GitLab%20Pages&color=orange
-        :target: https://ipi-sar4infra.projektpages.uni-h.de/timeseries/doc/
+.. image:: https://img.shields.io/static/v1?label=Documentation&message=GitHub%20Pages&color=blue
+        :target: https://luhipi.github.io/sarvey/docs/
         :alt: Documentation
 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.12544131.svg
         :target: https://doi.org/10.5281/zenodo.12544131
@@ -53,7 +50,7 @@ If you use **SARvey** in your research, please cite the following.
 
 1. The paper describing the methodology:
 
-   Piter, A., Haghshenas Haghighi, M., Motagh, M.(2024). An in-depth study on Sentinel-1 InSAR for transport infrastructure monitoring. PFG - Journal of Photogrammetry, Remote Sensing and Geoinformation Science. (paper currently under review).
+   Piter, A., Haghshenas Haghighi, M., Motagh, M.(2024). Challenges and Opportunities of Sentinel-1 InSAR for Transport Infrastructure Monitoring. PFG - Journal of Photogrammetry, Remote Sensing and Geoinformation Science. (paper in press).
 
 2. The software itself. Please specify the version you use:
 
@@ -89,12 +86,12 @@ SARvey is a command-line-based software. The major steps for running SARvey are
   The software requires a coregistered stack of SLC and the related geometry information in the MiaplPy_  data format.
   The coregistered stack of SLC can be created using an InSAR processor. Currently MiaplPy_ only supports ISCE_. Support for GAMMA and SNAP_ is planned for future.
   After creating the coregistered stack of SLC, run the "load_data" step from Miaplpy_ to create the "inputs" directory which contains "slcStack.h5" and "geometryRadar.h5".
-  Details are explained in the `Preparation <preparation.html>`_ section
+  Details are explained in the preparation_ section
 
 
 * **Time series analysis**
 
-  Time series analysis is performed using `sarvey`. It consists of 5 steps (steps 0 to 4). The details of each step are explained in `processing steps <processing.html#processing-steps-for-two-step-unwrapping-workflow>`_. The processing parameters are handled in a json config file. Visualization and export are handled by `sarvey_plot` and `sarvey_export` packages. Below are the major steps:
+  Time series analysis is performed using `sarvey`. It consists of 5 steps (steps 0 to 4). The details of each step are explained in `processing steps`_. The processing parameters are handled in a json config file. Visualization and export are handled by `sarvey_plot` and `sarvey_export` packages. Below are the major steps:
 
   * Go to your working directory:
 
@@ -116,7 +113,7 @@ SARvey is a command-line-based software. The major steps for running SARvey are
 
          sarvey -f config.json 0 4
 
-    Different processing steps are explained `here <processing.html>`_.
+    Different processing steps are explained in `processing`_ section.
 
   * Plot the resulting displacement time series:
 
@@ -155,16 +152,15 @@ You can run each component in the command line with "-h" argument for more infor
 
 **SARvey** supports two processing schemes:
 
-* `Two-step unwrapping <processing.html#processing-steps-for-two-step-unwrapping-workflow>`_ with atmospheric correction (default).
-
-* `One-step unwrapping <processing.html#processing-steps-for-one-step-unwrapping-workflow>`_ for a small area.
+* `Two-step unwrapping`_ with atmospheric correction (default).
 
+* `One-step unwrapping`_ for a small area.
 
 History / Changelog
 -------------------
 
 You can find the protocol of recent changes in the **SARvey** package
-`here <HISTORY.rst>`__.
+`history`_.
 
 We follow the principle of semantic versioning.
 The version number is structured as follows: MAJOR.MINOR.PATCH.
@@ -188,10 +184,15 @@ This package was created with Cookiecutter_ and the `fernlab/cookiecutter-pypack
 
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _`fernlab/cookiecutter-pypackage`: https://github.com/fernlab/cookiecutter-pypackage
-.. _coverage: https://ipi-sar4infra.projektpages.uni-h.de/timeseries/coverage/
-.. _pytest: https://ipi-sar4infra.projektpages.uni-h.de/timeseries/test_reports/report.html
-.. _processing: docs/processing.html
-.. _`installation instruction`: docs/installation.html
+.. _coverage: https://luhipi.github.io/sarvey/coverage/
+.. _pytest: https://luhipi.github.io/sarvey/test_reports/report.html
+.. _processing: https://luhipi.github.io/sarvey/docs/processing.html
+.. _`processing steps`: https://luhipi.github.io/sarvey/docs/processing.html#processing-steps-for-two-step-unwrapping-workflow
+.. _preparation: https://luhipi.github.io/sarvey/docs/preparation.html
+.. _`Two-step unwrapping`: https://luhipi.github.io/sarvey/docs/processing.html#processing-steps-for-two-step-unwrapping-workflow
+.. _`One-step unwrapping`: https://luhipi.github.io/sarvey/docs/processing.html#processing-steps-for-one-step-unwrapping-workflow
+.. _`installation instruction`: https://luhipi.github.io/sarvey/docs/installation.html
+.. _`history`: https://luhipi.github.io/sarvey/docs/history.html
 .. _MiaplPy: https://github.com/insarlab/MiaplPy
 .. _ISCE: https://github.com/isce-framework/isce2
 .. _SNAP: https://step.esa.int/main/toolboxes/snap

docs/processing.rst

@@ -325,7 +325,7 @@ Since the densification step is not performed, you should reduce the coherence t
 Literature
 ----------
 
-* Piter, A., Haghshenas Haghighi, M., Motagh, M.(2024). An in-depth study on Sentinel-1 InSAR for transport infrastructure monitoring. PFG - Journal of Photogrammetry, Remote Sensing and Geoinformation Science. (paper currently under review).
+* Piter, A., Haghshenas Haghighi, M., Motagh, M.(2024). Challenges and Opportunities of Sentinel-1 InSAR for Transport Infrastructure Monitoring. PFG - Journal of Photogrammetry, Remote Sensing and Geoinformation Science. (paper in press).
 
 * Zhao F, Mallorqui JJ (2019). A Temporal Phase Coherence Estimation Algorithm and Its Application on DInSAR Pixel Selection. IEEE Transactions on Geoscience and Remote Sensing 57(11):8350–8361, DOI 10.1109/TGRS.2019.2920536