diff --git a/.vuepress/config.js b/.vuepress/config.js index b70e3f6ce..a0ccac0c8 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -14,6 +14,7 @@ module.exports = { nav: [ { text: 'Datasets', link: '/data-collections/' }, { text: 'Get Started', items: [ + { text: 'Free Trial Registration', link: '/join/free_trial.html' }, { text: 'Data Cubes', link: 'https://openeo.org/documentation/1.0/datacubes.html' }, { text: 'Client Libraries', items: [ { text: 'JavaScript', link: '/getting-started/javascript/' }, @@ -24,8 +25,8 @@ module.exports = { { text: 'JupyterLab (Python)', link: '/getting-started/jupyterlab/' }, { text: 'Editor', link: '/getting-started/editor/' } ] }, - { text: 'Free Trial Registration', link: '/join/free_trial.html' }, { text: 'Cookbook', link: 'https://openeo.org/documentation/1.0/cookbook/' }, + { text: 'Client-Side Processing (Python)', link: '/getting-started/client-side-processing/' }, ] }, { text: 'Clients', items: [ { text: 'JavaScript', link: 'https://open-eo.github.io/openeo-js-client/latest/' }, diff --git a/getting-started/client side processing/index.md b/getting-started/client-side-processing/index.md similarity index 93% rename from getting-started/client side processing/index.md rename to getting-started/client-side-processing/index.md index 4d4a08c1e..5513f8f71 100644 --- a/getting-started/client side processing/index.md +++ b/getting-started/client-side-processing/index.md @@ -7,10 +7,8 @@ It relies on the projects [openeo-pg-parser-networkx](https://github.com/Open-EO ## Installation -::: danger Important - +::: warning Important This feature requires ``Python>=3.9``. - ::: The openEO Python client library can easily be installed with a tool like `pip`, for example: @@ -26,10 +24,9 @@ Every openEO process graph relies on data which is typically provided by a cloud The client-side processing adds the possibility to read and use local netCDFs, geoTIFFs, ZARR files, and remote STAC Collections or Items for your experiments. ### STAC Collections and Items -::: danger Important +::: warning Important The provided examples using STAC rely on third party STAC Catalogs, we can't guarantee that the urls will remain valid. - ::: With the `load_stac` process it's possible to load and use data provided by remote or local STAC Collections or Items. @@ -105,9 +102,10 @@ local_conn.list_collections() This code will parse the metadata content of each netCDF, geoTIFF or ZARR file in the provided folders and return a JSON object containing the STAC representation of the metadata. If this code is run in a Jupyter Notebook, the metadata will be rendered nicely. -.. tip:: - The code expects local files to have a similar structure to the sample files provided [here](https://github.com/Open-EO/openeo-localprocessing-data.git). - If the code can not handle you special netCDF, you can still modify the function that reads the metadata from it [here](https://github.com/Open-EO/openeo-python-client/blob/master/openeo/local/collections.py) and the function that reads the data [here](https://github.com/Open-EO/openeo-python-client/blob/master/openeo/local/processing.py). +::: tip +The code expects local files to have a similar structure to the sample files provided [here](https://github.com/Open-EO/openeo-localprocessing-data.git). +If the code can not handle you special netCDF, you can still modify the function that reads the metadata from it [here](https://github.com/Open-EO/openeo-python-client/blob/master/openeo/local/collections.py) and the function that reads the data [here](https://github.com/Open-EO/openeo-python-client/blob/master/openeo/local/processing.py). +::: ### Local Processing @@ -179,6 +177,7 @@ result_ndvi = ndvi_median.execute() ``` ## Client-Side Processing Example Notebooks + * [From the openEO Python Client repo](https://github.com/Open-EO/openeo-python-client/tree/master/examples/notebooks/Client_Side_Processing) * [From the Cubes and Clouds repo](https://github.com/EO-College/cubes-and-clouds/blob/main/lectures/3.1_data_processing/exercises/_alternatives/31_data_processing_stac.ipynb) @@ -191,4 +190,4 @@ Additional information and resources about the openEO Python Client Library: * [Example Python scripts](https://github.com/Open-EO/openeo-python-client/tree/master/examples) * [Example Jupyter Notebooks](https://github.com/Open-EO/openeo-python-client/tree/master/examples/notebooks) * [Repository on GitHub](https://github.com/Open-EO/openeo-python-client) -* [Run openEO processes in a Python Shiny App](./shiny.md) +* [Run openEO processes in a Python Shiny App](../python/shiny.md)