mirror of
https://github.com/heyarne/earth-observation-for-journalism.git
synced 2026-05-06 19:13:40 +02:00
Create pipeline for spectral indices w/ correct cloud masking
This commit is contained in:
parent
dec537d2d6
commit
17b250815b
15 changed files with 1273 additions and 83 deletions
35
sentinel_data_for_earth_observation/README.md
Normal file
35
sentinel_data_for_earth_observation/README.md
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
# Sentinel Data for Earth Observation
|
||||
|
||||
This cookiecutter creates a simple boilerplate for a Jupyter Book.
|
||||
|
||||
## Usage
|
||||
|
||||
### Building the book
|
||||
|
||||
If you'd like to develop on and build the Sentinel Data for Earth Observation book, you should:
|
||||
|
||||
- Clone this repository and run
|
||||
- Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
|
||||
- (Recommended) Remove the existing `Sentinel Data for Earth Observation/_build/` directory
|
||||
- Run `jupyter-book build Sentinel Data for Earth Observation/`
|
||||
|
||||
A fully-rendered HTML version of the book will be built in `Sentinel Data for Earth Observation/_build/html/`.
|
||||
|
||||
### Hosting the book
|
||||
|
||||
The html version of the book is hosted on the `gh-pages` branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to main.
|
||||
|
||||
If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:
|
||||
|
||||
- Navigating to your local build; and running,
|
||||
- `ghp-import -n -p -f Sentinel Data for Earth Observation/_build/html`
|
||||
|
||||
This will automatically push your build to the `gh-pages` branch. More information on this hosting process can be found [here](https://jupyterbook.org/publish/gh-pages.html#manually-host-your-book-with-github-pages).
|
||||
|
||||
## Contributors
|
||||
|
||||
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/heyarne/sentinel_data_for_earth_observation/graphs/contributors).
|
||||
|
||||
## Credits
|
||||
|
||||
This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).
|
||||
Loading…
Add table
Add a link
Reference in a new issue