Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme to reflect stable install #391

Merged
merged 16 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,17 @@ Below we list the dependencies for ARIA-tools

------
## Installation
ARIA-tools package can be easily installed and used after the dependencies are installed and activated. The third-party RelaxIV package is optional (not required), and only used when opting to minimizing phase-discontinuities. Prior to use of RelaxIV, users should conform to the RelaxIV license agreement. The easiest way of installing RelaxIV is by downloading the min-cost-flow repository in the third-party folder of the ARIAtools and using the setup.py script as outlined below. For the required dependencies, we strongly recommend using [Anaconda](https://www.anaconda.com/distribution/) package manager for easy installation of dependencies in the python environment.
ARIA-tools package can be easily installed and used after the dependencies are installed and activated. The third-party RelaxIV package is optional (not required), and only used when opting to minimizing phase-discontinuities. Prior to use of RelaxIV, users should conform to the RelaxIV license agreement. The easiest way of installing RelaxIV is by downloading the min-cost-flow repository in the third-party folder of the ARIAtools and using the setup.py script as outlined below.

__[Conda](https://docs.conda.io/en/latest/index.html)__ is a cross-platform way to use Python that allows you to setup and use "virtual environments," which allows for the easy installation and management of all of the required dependencies. We recommend using the [Miniforge](https://github.com/conda-forge/miniforge) conda environment manager, which uses conda-forge as its default code repo. Alternatively, see __[here](https://docs.anaconda.com/anaconda/install/)__ for help installing Anaconda and __[here](https://docs.conda.io/en/latest/miniconda.html)__ for installing Miniconda.

### Conda
Below we outline the different steps for setting up the ARIA-tools while leveraging Anaconda for installation of the requirements. Run the commands below to download/clone the ARIA-tools package to your local directory. It is advised to use `mamba` as prompted to speed the install up:
Below we outline the different steps for setting up the ARIA-tools while leveraging Anaconda for installation of the requirements. Run the commands below to download/clone the ARIA-tools package to your local directory.:

```.tcsh
conda install mamba
wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh
bash Miniforge3-Linux-x86_64.sh -b -p miniforge
miniforge/bin/mamba init tcsh
git clone https://github.com/aria-tools/ARIA-tools.git
cd ARIA-tools
```
Expand Down Expand Up @@ -104,7 +108,7 @@ setenv PATH ${PATH}:${PWD}/tools/ARIAtools

To avoid potential issues associated with dependencies when cloning new ARIA-tools commits, it is advised to regularly maintain your conda environment as so (making sure to adjust the conda environment argument name `--name ARIA-tools` as appropriate):
```.tcsh
mamba env update --name ARIA-tools --file environment.yml --prune
conda env update --name ARIA-tools --file environment.yml --prune
```

### Other installation options
Expand Down Expand Up @@ -141,6 +145,8 @@ export VSI_CACHE=YES

The ARIA-tools scripts are highly modulized in Python and therefore allows for building your own processing workflow. Below, we show how to call some of the functionality. For detailed documentation, examples, and Jupyter notebooks see the [ARIA-tools-docs repository](https://github.com/aria-tools/ARIA-tools-docs). We welcome the community to contribute other examples on how to leverage the ARIA-tools (see [here](https://github.com/aria-tools/ARIA-tools/blob/master/CONTRIBUTING.md) for instructions).

* NOTE, currently ARIA-tools does not support deduplication (we are working to add it soon though), so for each commandline input please make sure to specify a fresh output directory with the `--workdir` option.

### Commandline download of GUNW Products
GUNW products can be downloaded through the commandline using the *ariaDownload.py* program, which wraps around the ASF DAAC api.

Expand Down
10 changes: 3 additions & 7 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ channels:
dependencies:
- python>=3.8
- asf_search
- cartopy
- dem_stitcher>=2.5.0
- gdal>=3.4.1
- h5py
Expand All @@ -25,11 +24,8 @@ dependencies:
- pyproj
- requests
- scipy>1.10.0
- mintpy
- shapely
- dask
#for ARIA-tools-docs
- jupyterlab

- pip:
- rise
- jupyter_contrib_nbextensions
#- jupyterlab
#- jupyter_contrib_nbextensions
3 changes: 1 addition & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
python>=3.8
asf_search
cartopy
dem_stitcher>=2.5.0
gdal>=3.4.1
h5py
Expand All @@ -16,7 +15,7 @@ pyproj
requests
scipy>1.10.0
shapely
dask
## notebook dependencies, keep commented out for better compatiability with other codes
#jupyterlab
#jupyter_contrib_nbextensions
#rise
Loading