Skip to content
Snippets Groups Projects
Commit bab86761 authored by Rudolf, Michael's avatar Rudolf, Michael
Browse files

Update for autodocs

parent 7e7c3158
No related branches found
No related tags found
No related merge requests found
...@@ -4,6 +4,14 @@ This repository contains an installable Python module, Jupyter notebooks and scr ...@@ -4,6 +4,14 @@ This repository contains an installable Python module, Jupyter notebooks and scr
## Installation ## Installation
### Prerequisites
This module uses [GDAL](https://gdal.org) which cannot be installed from pypi for many operating systems. You can download precompiled binary wheels from [here](https://github.com/cgohlke/geospatial-wheels/releases).
Some scripts use ADAtools by Barra et al. 2017, Tomás et al. 2019 and Navarro et al. 2020. If this functionality is needed, please contact one of the authors for a personal copy of ADAtools.
### Setup
To install the module you need to use pip together with git: To install the module you need to use pip together with git:
```bash ```bash
...@@ -14,6 +22,14 @@ This automatically installs the module u4py including all prerequisites to your ...@@ -14,6 +22,14 @@ This automatically installs the module u4py including all prerequisites to your
## Documentation ## Documentation
You can find an automatically generated documentation at <https://rudolf.pages.git-ce.rwth-aachen.de/u4py/>. You can find an automatically generated documentation [here](https://rudolf.pages.git-ce.rwth-aachen.de/u4py/).
Currently, the python module `u4py` and the `scripts` are mainly for the analysis of persistent scatterer interferometry data (PSI). The Jupyter `notebooks` additionally use digital elevation models, height differences and further information. Currently, the python module `u4py` and the `scripts` are mainly for the analysis of persistent scatterer interferometry data (PSI). The Jupyter `notebooks` additionally use digital elevation models, height differences and further information.
## References
- A. Barra, L. Solari, M. Béjar-Pizarro, O. Monserrat, S. Bianchini, G. Herrera, M. Crosetto, R. Sarro, A. G.E., R. Maria Mateos, S. Ligüerzana, C. López, S. Moretti, A Methodology to Detect and Update Active Deformation Areas Based on Sentinel-1 SAR Images , Remote Sensing, Vol. 9, No. 10, September 2017.
- R. Tomás, J. Ignacio Pagán, J. A. Navarro, M. Cano, J. Luis Pastor, A. Riquelme, M. Cuevas-González, M. Crosetto, A. Barra, O. Monserrat, J. M. López-Sánchez, A. Ramón, S. Iborra, M. del Soldato, L. Solari, S. Bianchini, F. Raspini, F. Novali, A. Ferreti, M. Constantini, F. Trillo, G. Herrera, N. Casagli, Semi-Automatic Identification and Pre-Screening of Geological-Geotechnical Deformational Processes Using Persistent Scatterer Interferometry Datasets , Remote Sensing, Vol. 11, No. 14, July 2019.
- J. A. Navarro, R. Tomás, A, Barra, J. I. Pagán, C. Reyes-Carmona, L. Solari, J. L.Vinielles, S. Falco, M. Crosetto, ADAtools: Automatic Detection and Classification of Active Deformation Areas from PSI Displacement Maps. ISPRS Int. J. Geo-Inf. 2020, 9, 584.
...@@ -7,9 +7,9 @@ ...@@ -7,9 +7,9 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "U4Py" project = "U4Py"
copyright = "2023, M. Rudolf" copyright = "2024, M. Rudolf"
author = "M. Rudolf" author = "M. Rudolf"
release = "0.0.2dev" release = "0.0.7beta"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
...@@ -28,9 +28,7 @@ autodoc_default_options = { ...@@ -28,9 +28,7 @@ autodoc_default_options = {
"member-order": "bysource", "member-order": "bysource",
"special-members": "__init__", "special-members": "__init__",
} }
autodoc_mock_imports = [
"GDAL",
]
language = "en" language = "en"
......
...@@ -9,7 +9,8 @@ install_requires= ...@@ -9,7 +9,8 @@ install_requires=
contextily contextily
ffmpeg_python ffmpeg_python
fiona fiona
GDAL GDAL == 3.6.2;platform_system=="Linux"
GDAL >= 3.8.3;platform_system=="Windows"
geopandas geopandas
geopy geopy
ipython ipython
......
"""
**Scripts**
This folder contains scripts that use the u4py module for data preparation, analysis and plotting. Most of them require u4py to be installed on the system to work.
| `data_analysis`: Analysis scripts for inversion or other timeseries analysis.
| `data_preparation`: Data preparation for u4py, e.g. converting original data.
| `examples`: Case studies and similar examples.
| `gis_workflows`: Workflows making use of GIS functions
| `helpers`: Data preparation or plotting that is not directly related to u4py.
| `playground`: Some scripts that are either WIP or to explore the data.
| `plotting`: Scripts for plotting or visualizing data, sometimes including analysis.
"""
from . import (
data_analysis,
data_preparation,
examples,
gis_workflows,
helpers,
playground,
plotting,
)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment