Skip to content

Commit

Permalink
docs: Refine install instructions
Browse files Browse the repository at this point in the history
Mention Nix as the default, since it's far easier to set up.

Move download section above setup, to simplify the instructions.
  • Loading branch information
l0b0 authored and kodiakhq[bot] committed Jun 1, 2023
1 parent 14738ea commit 23995d1
Showing 1 changed file with 35 additions and 31 deletions.
66 changes: 35 additions & 31 deletions flooding/sentinel2_water_extraction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,52 +5,56 @@ from Sentinel-2 optical imagery.

Below are the instructions to get the notebook up and running.

## Prerequisites

- Linux, macOS, or Windows
- Python
- [Poetry](https://python-poetry.org/docs/#installation)

[Tested](.github/workflows/test.yml) with:

- OS:
- Ubuntu 22.04 (Jammy Jellyfish)
- macOS 12 (Monterey)
- Windows Server 2022
- Python:
- 3.8
- 3.9
- 3.10
- 3.11

## Get the Jupyter Notebook

If you just want the _latest contents:_

1. [Download the repository](https://github.com/linz/emergency-management-tools/archive/refs/heads/master.zip)
1. Unpack the zip file using a file explorer or `unzip master.zip` on the
command line
1. Go to the relevant directory with
`cd [download path]/emergency-management-tools-master/flooding/sentinel2_water_extraction`

If you would like the _full repository history,_ for example to do some
development yourself:
development yourself, clone this repository with
`git clone [email protected]:linz/emergency-management-tools.git`

## Setup

### Nix

If you are running Linux, macOS, or a Windows machine with WSL, this is the
easiest setup. The only dependency is the
[Nix package manager](https://nixos.org/download.html). Please select your
platform and follow the instructions.

Once Nix is installed,
`cd [emergency-management-tools path]/flooding/sentinel2_water_extraction` and
run `nix-shell` to install all the dependencies. This could take a long time the
first time it runs.

### Non-nix

1. Clone this repository with
`git clone [email protected]:linz/emergency-management-tools.git`
1. Go to the relevant directory with
`cd emergency-management-tools/flooding/sentinel2_water_extraction`
If you can't use Nix, you will need the following. For each prerequisite, the
[automatically tested](.github/workflows/test.yml) version is included.

## Install dependencies
- One of these operating systems:
- Linux (tested on Ubuntu 22.04, Jammy Jellyfish)
- macOS (tested on version 12, Monterey)
- Windows (tested on Windows Server 2022)
- [Python](https://www.python.org/downloads/) (tested with 3.8, 3.9, 3.10, and
3.11)
- [Poetry](https://python-poetry.org/docs/#installation) (tested with 1.3.2)
- [GDAL](https://gdal.org/download.html) (tested with 3.6.4)

Install the dependencies for this project with
`poetry install --only=main --no-root`.
Once you have all of the above,
`cd [emergency-management-tools path]/flooding/sentinel2_water_extraction` and
install Python packages for this project with
`poetry install --only=main --no-root`. Finally run `poetry shell` to make the
Python packages available.

## Start the Jupyter Notebook

Start the notebook with
`poetry run jupyter notebook sentinel2_water_extraction.ipynb`. This will open
the notebook in a browser.
Start the notebook with `jupyter notebook sentinel2_water_extraction.ipynb`.
This will open the notebook in a browser.

## Extract water from Sentinel-2 imagery

Expand Down

0 comments on commit 23995d1

Please sign in to comment.