diff --git a/README.md b/README.md index 31176a6438995b42eb2da29007bec8de9b94837d..24fb35dc844f6994e1074b4560ab7b09d0f92c72 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ This repository contains an installable Python module, Jupyter notebooks and scr ## 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: ```bash @@ -14,6 +22,14 @@ This automatically installs the module u4py including all prerequisites to your ## 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. + +## 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. diff --git a/doc/source/conf.py b/doc/source/conf.py index 2aded946aa3d90c00c18909b9f484a6f99a21e86..1700f3a29dc524923ec4c91029f6669131662035 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -7,9 +7,9 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "U4Py" -copyright = "2023, M. Rudolf" +copyright = "2024, M. Rudolf" author = "M. Rudolf" -release = "0.0.2dev" +release = "0.0.7beta" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -28,9 +28,7 @@ autodoc_default_options = { "member-order": "bysource", "special-members": "__init__", } -autodoc_mock_imports = [ - "GDAL", -] + language = "en" diff --git a/setup.cfg b/setup.cfg index 82edca1e2bad6703a9ea99aca3bf50415b1cf356..1ce87774b3d0ac867dd7a0437122be63852a2176 100644 --- a/setup.cfg +++ b/setup.cfg @@ -9,7 +9,8 @@ install_requires= contextily ffmpeg_python fiona - GDAL + GDAL == 3.6.2;platform_system=="Linux" + GDAL >= 3.8.3;platform_system=="Windows" geopandas geopy ipython diff --git a/u4py/scripts/__init__.py b/u4py/scripts/__init__.py deleted file mode 100644 index 8471e17b8701c01dde5b48dd2a0f674232baf7eb..0000000000000000000000000000000000000000 --- a/u4py/scripts/__init__.py +++ /dev/null @@ -1,24 +0,0 @@ -""" -**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, -) diff --git a/u4py/scripts/tests/byte_decoder.py b/u4py/scripts/codetests/byte_decoder.py similarity index 100% rename from u4py/scripts/tests/byte_decoder.py rename to u4py/scripts/codetests/byte_decoder.py diff --git a/u4py/scripts/tests/lookup_inv_results.py b/u4py/scripts/codetests/lookup_inv_results.py similarity index 100% rename from u4py/scripts/tests/lookup_inv_results.py rename to u4py/scripts/codetests/lookup_inv_results.py diff --git a/u4py/scripts/tests/seasonal_max.py b/u4py/scripts/codetests/seasonal_max.py similarity index 100% rename from u4py/scripts/tests/seasonal_max.py rename to u4py/scripts/codetests/seasonal_max.py