Update the environment files and install instructions (#196)

* make more up to date conda `environment.yml` file, split test requirements * update install instructions * add pillow, upper pin scipy * add s1reader to env * activate env before pip installing Co-authored-by: Liang Yu <[email protected]> * typos and make `getting-started` match README --------- Co-authored-by: Liang Yu <[email protected]>
opera-adt · Aug 8, 2023 · 7d7fc9d · 7d7fc9d
1 parent aa75180
commit 7d7fc9d
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -8,25 +8,19 @@ COregistered Multi-temPorAl Sar Slc
 
 The following will install COMPASS into a conda environment.
 
-1. Download source code:
-
 ```bash
-git clone https://github.com/opera-adt/COMPASS.git
+conda install -c conda-forge compass
 ```
 
-2. Install dependencies:
+Alternatively, you can install in development mode:
 
 ```bash
-conda install -c conda-forge --file COMPASS/requirements.txt
-python -m pip install git+https://github.com/opera-adt/s1-reader.git
+git clone https://github.com/opera-adt/COMPASS.git && cd COMPASS
+conda env create --file environment.yml
+conda activate compass
+python -m pip install -e .
 ```
 
-3. Install `COMPASS` via pip:
-
-```bash
-# run "pip install -e" to install in development mode
-python -m pip install ./COMPASS
-```
 
 ### Usage
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -2,25 +2,19 @@
 
 The following will install COMPASS into a conda environment.
 
-1. Download source code:
-
 ```bash
-git clone https://github.com/opera-adt/COMPASS.git
+conda install -c conda-forge compass
 ```
 
-2. Install dependencies:
 
-```bash
-conda install -c conda-forge --file COMPASS/requirements.txt
-python -m pip install git+https://github.com/opera-adt/s1-reader.git
-```
-
-3. Install `COMPASS` via pip:
+Alternatively, you can install in development mode:
 
 ```bash
-# run "pip install -e" to install in development mode
-python -m pip install ./COMPASS
-``` 
+git clone https://github.com/opera-adt/COMPASS.git && cd COMPASS
+conda env create --file environment.yml
+conda activate compass
+python -m pip install -e .
+```
 
 ## Usage
 

diff --git a/environment.yml b/environment.yml
@@ -0,0 +1,19 @@
+name: compass
+channels:
+  - conda-forge
+dependencies:
+  - python>=3.8
+  - numpy>=1.20
+  - gdal>=3.3
+  - isce3>=0.14.0
+  - pandas>=1.4
+  - pillow>=7.0
+  - pyproj>=3.3
+  - pysolid>=0.3
+  - ruamel.yaml>=0.15
+  - scipy>=1.0,<1.13
+  - yamale>=4.0
+  - h5py>=3.5
+  - s1reader>=0.2.0
+  - shapely>=1.8
+  - requests>=2.0
diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -0,0 +1,2 @@
+pytest
+pytest-order