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.

Sign up for GitHub

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

Actinia Tutorials Update #350

Merged
merged 3 commits into from
May 25, 2022
Merged

Actinia Tutorials Update #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a82977f
edited index.md
Momen-Mawad May 6, 2022
036240c
Update docs/README.md
Momen-Mawad May 25, 2022
04776e6
Update docs/docs/index.md
Momen-Mawad May 25, 2022
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
3 changes: 3 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Depoly
* cd to actinia_core/docs/ folder
* run the command `mkdocs gh-deploy`
34 changes: 22 additions & 12 deletions docs/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,26 @@ example all Landsat 4-8 scenes as well as all Sentinel-2 scenes in an
ephemeral databases. The computational results of ephemeral processing
are available via object storage as GeoTIFF files.

The full API documentation is available here:
The full API documentation is available here: <https://actinia.mundialis.de/api_docs/>

<https://actinia.mundialis.de/api_docs/>

::: {.toctree maxdepth="2"}
Introduction \<introduction\> Introduction \<actinia\_concepts\>
Installation \<installation\> Actinia database access
\<tutorial\_data\_access\> Time-series sampling
\<tutorial\_strds\_sampling\> Landsat NDVI computation
\<tutorial\_landsat\_ndvi\> Sentinel-2A NDVI computation
\<tutorial\_sentinel2a\_ndvi\> User defined processing
\<tutorial\_process\_chain\> License \<license\> Authors \<authors\>
:::
* Introduction
* What is REST?
* Examples
* Actinia REST API documentation
* User, user-roles and user-groups
* The Actinia databases
* Installation
* Actinia database access
* Using curl for HTTP requests
* Access to locations and mapsets in the persistent database
* Access to raster layers in the persistent database
* Access to raster time-series in the persistent database
* Time-series sampling
* Sampling of a STRDS with vector points
* Landsat NDVI computation
* Sentinel-2 NDVI computation
* User defined processing
* The actinia process chain
* Sentinel-2A NDVI process chain
* License
* Authors
11 changes: 11 additions & 0 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,14 @@ docs_dir: docs
theme: readthedocs
# https://github.com/mkdocs/mkdocs/issues/991
use_directory_urls: true
nav:
- Home: 'index.md'
- Introduction: 'introduction.md'
- Installation: 'installation.md'
- Actinia database access: 'tutorial_data_access.md'
- Time-series sampling: 'tutorial_strds_sampling.md'
- Landsat NDVI computation: 'tutorial_landsat_ndvi.md'
- Sentinel-2A NDVI computation: 'tutorial_sentinel2_ndvi.md'
- User defined processing: 'tutorial_process_chain.md'
- License: 'license.md'
- Authors: 'authors.md'