SenSARP

This repository contains the functionality for Sentinel-1 SAR-Pre.Processing of the MULTIPLY main platform. The SenSARP specific documentation is hosted on ReadTheDocs. It is part of the MULTIPLY core documentation. Please find the pdf version of the SenSARP documentation here and for the MULTIPLY platform here.

Content of this repository

docs/ - The auto generated documentation
recipe/ Conda installation recipe
sar_pre_processing/ - The main sar pre processing software package
test/ - The test package.
AUTHORS.rst - Author information.
CHANGES.md - Package change log.
LICENSE.rst - License of software in repository.
README.md - Readme.
environmental.yml - Requirements.
sar_pre_processing_CLI.txt - Renaming package to SenSARP
setup.py - main build script, to be run with Python 3.6

How to install

The first step is to clone the latest code and step into the check out directory:

$ git clone https://github.com/multiply-org/sar-pre-processing.git
$ cd sar-pre-processing

The MULTIPLY platform has been developed against Python 3.6. It cannot be guaranteed to work with previous Python versions.

MULTIPLY SAR-pre-processing can be run from sources directly. To install all required modules, use

$ conda env create --prefix ./env --file environment.yml
$ conda activate ./env # activate the environment

To install MULTIPLY SAR-pre-processing into an existing Python environment just for the current user, use

$ python setup.py install --user

To install for development and for the current user, use

$ python setup.py develop --user

Module requirements

Please see the environment file for a list of dependencies. ESA's SNAP Sentinel-1 Toolbox has to be installed prerequisite. The Software can be downloaded here

SNAP Toolbox need libgfortran for specific operations but currently libgfortran is not installed during the installation process of SNAP (Linux version) therefore you might use

$ sudo apt-get install gfortran

Usage

For usage checkout the juypter notebook

Documentation

We use Sphinx to generate the documentation of the MULTIPLY platform on ReadTheDocs. The SAR-Pre-Processing specific documentation is available here

Contribution and Development

You are very welcome to contribute to MULTIPLY SAR-Pre-Processing. To do so, please first make a fork into your own repository and then create a Pull Request.

Reporting issues and feedback

If you encounter any bugs with the tool, please file a new issue.

Authors

License

This project is licensed under the GPLv3 License - see the LICENSE.rst file for details.

LiuChunxiu / sar-pre-processing