diff --git a/instantiation/catalog.qmd b/instantiation/catalog.qmd index 8080176..40fd511 100644 --- a/instantiation/catalog.qmd +++ b/instantiation/catalog.qmd @@ -133,6 +133,7 @@ The following guides showcase how you can interact with the catalogue API: | APEx | [https://browser.apex.esa.int](https://browser.apex.esa.int/?.language=en) | | APEx (Demo) | [https://browser.demo.apex.esa.int](https://browser.demo.apex.esa.int/?.language=en) | | World Ecosystem Extent Dynamics (WEED) | [https://browser.weed.apex.esa.int](https://browser.weed.apex.esa.int/?.language=en) | +| EO4SEM | [https://browser.eo4sem.apex.esa.int](https://browser.eo4sem.apex.esa.int) | : APEx Product Catalogue - Project Examples {#tbl-catalogue-examples}{tbl-colwidths="[30,70]"} diff --git a/instantiation/customisation.md b/instantiation/customisation.md index 96ea176..02d8288 100644 --- a/instantiation/customisation.md +++ b/instantiation/customisation.md @@ -2,16 +2,15 @@ title: Customisation --- -The APEx Project Environments are designed to adapt to the unique needs of each project. Except for the User Workspace and -IDE service, which are offered as a combined package, all other services can be requested and instantiated independently. -This modular approach allows projects to select only the tools that align with their specific requirements. Each service -is accessible via a public URL, enabling seamless integration into existing project components. +The APEx Project Environments are designed to adapt to the unique needs of each project. All services can be requested and +instantiated independently. This modular approach allows projects to select only the tools that align with their specific +requirements. Each service is accessible via a public URL, enabling seamless integration into existing project components. In addition to the flexibility of service selection, each service can be customised to reflect the project's branding and aesthetics. The degree of customisation depends on the capabilities of the underlying software, typically focusing on general visual elements such as logos and colour schemes. -Currently, customisation is performed during the instantiation process in close collaboration with the project team. As the -APEx project evolves, additional mechanisms to streamline and enhance service customisation will be explored. For projects +Currently, customisation is performed during the instantiation process in close collaboration with the project team. As +the APEx project evolves, additional mechanisms to streamline and enhance service customisation will be explored. For projects requiring more detailed adjustments, APEx will provide access to the software’s technical documentation, empowering teams to further tailor the services to their needs. diff --git a/instantiation/geospatial_explorer.md b/instantiation/geospatial_explorer.md index 40c166b..3047380 100644 --- a/instantiation/geospatial_explorer.md +++ b/instantiation/geospatial_explorer.md @@ -27,6 +27,11 @@ rendered in the Explorer. | APEx (Demo) | [https://explorer.demo.apex.esa.int/](https://explorer.demo.apex.esa.int/) | | SEF - Food Systems | [https://explorer.sef-food.apex.esa.int/](https://explorer.sef-food.apex.esa.int/) | | SEF - Ecosystems & Biodiversity | [https://explorer.sef-ecosystems.apex.esa.int/](https://explorer.sef-ecosystems.apex.esa.int/) | +| SEF - Urban | [https://explorer.sef-urban.apex.esa.int/](https://explorer.sef-urban.apex.esa.int/) | +| EOBPs – Road and Railway | [https://explorer.eobp-transport.apex.esa.int/](https://explorer.eobp-transport.apex.esa.int/) | +| EOBPs – Solar Energy | [https://explorer.eobp-energy.apex.esa.int/](https://explorer.eobp-energy.apex.esa.int/) | +| EOBPs – Health | [https://explorer.eobp-health.apex.esa.int/](https://explorer.eobp-health.apex.esa.int/) | +| EO4SEM | [https://explorer.eo4sem.apex.esa.int/](https://explorer.eo4sem.apex.esa.int/) | : APEx Geospatial Explorer - Project Examples {#tbl-explorer-examples}{tbl-colwidths="[20,80]"} diff --git a/instantiation/index.md b/instantiation/index.md index da08a62..b3a4501 100644 --- a/instantiation/index.md +++ b/instantiation/index.md @@ -8,9 +8,9 @@ These tools are crucial for facilitating the effective sharing, maintenance, and the Earth Observation community, ensuring that they remain readily accessible and usable for extended time periods. APEx aims to cater to the diverse and multifaceted needs of the EO community by delivering Project Environments as Software -as a Service (SaaS) products. It manages the delivery of either single-user or shared environments, managed within a -unified cloud infrastructure, thus facilitating a wide range of user tasks, including development, hosting, execution, -and exploratory analysis of EO applications. +as a Service (SaaS) products. It manages the delivery of either user-specific or project-wide services within a single +project environment, managed within a unified cloud infrastructure, thus facilitating a wide range of user tasks, including +development, hosting, execution, and exploratory analysis of EO applications. At the core of the APEx Project Environments is the ability for APEx to manage and deliver these environments effectively. Project-wide community-oriented tools, such as the Project Web Portal, Product Catalogue, Documentation Portal, and User @@ -20,9 +20,10 @@ data across these Apps. These tools, including the User Workspace Finder, the Co Environment (IDE),the JupyterLab workspace, the QGIS user workspace, and in certain cases, dashboards and web applications, are all managed by a dedicated ApplicationHub server. This ApplicationHub orchestrates the launch and management of such software deployments,ensuring secured (isolated from other users) and customisable environments for individual users, while -allowing targeted file sharing operations among users. +allowing targeted file sharing operations among the range of user-launched applications, as well as potentially (depending +on the permissions being configured) with selected other users. -A key feature of the APEx Project Environments is the ability to provide managed, configurable environments. +A key feature of the APEx Project Environments is the ability to provide managed, configurable project environments. These environments can be tailored to the specific needs of different projects and users, supporting various tasks, including exploratory analysis, development, hosting, and execution of EO applications. This flexibility and configurability allow the project members to focus on their primary research objectives @@ -31,9 +32,10 @@ without being bogged down by the technical complexities of setting up and mainta Another critical component of the APEx Instantiation Services is the seamless integration with the [ESA's Network of Resources (NoR)](https://nor-discover.org/en/portfolio/). The focus is on developing new tools, which are meant to enrich the current NoR Portfolio offering. These new tools are being onboarded into the NoR, making -them available as purchasable services. For services that already exist in the NoR Portfolio, such as the ELLIP Studio IDE, the goal is to -integrate these through coordination with their provider(s). The technical challenge lies in achieving seamless integration and alignment of -business models, ensuring that newly developed and existing services work harmoniously within the APEx. +them available as purchasable services. For services that already exist, such as the ELLIP Studio IDE, the goal is to embed +these existing services into a given APEx offering on NoR, through coordination with their provider(s). The technical +challenge lies in achieving seamless integration and alignment of business models, ensuring that newly developed and existing +services work harmoniously for the users of the APEx platform. The specific components of the APEx Project Environments include: @@ -45,7 +47,8 @@ The specific components of the APEx Project Environments include: * [**Code Server IDE**](app_code_server.md)\ - Leveraging IDE capabilities tailored specifically for EO tasks, based on the open-source software Code Server (VS Code in the browser). + Leveraging IDE capabilities tailored specifically for EO tasks, based on the open-source software Code Server (VS Code + in the browser). * [**JupyterLab IDE**](app_jupyterlab.md)\ Leveraging IDE capabilities tailored specifically for EO tasks, based on open-source software JupyterLab. * [**QGIS on a Remote Desktop**](app_qgis.md)\ @@ -73,13 +76,14 @@ Projects can interconnect their instantiated services in several ways: * **Integrated Navigation**: If a project already has a public-facing website or uses the APEx [Project Web Portal](./project_portal.md), links to the instantiated tools, such as the -[Geospatial Explorer](./geospatial_explorer.md), [Product Catalogue](./catalog.qmd) or [JupyterLab](./app_jupyterlab.md), can be -embedded directly into the site's navigation structure. This provides a unified access point for project stakeholders +[Geospatial Explorer](./geospatial_explorer.md), [Product Catalogue](./catalog.qmd) or [JupyterLab](./app_jupyterlab.md), +can be embedded directly into the site's navigation structure. This provides a unified access point for project stakeholders and visitors to the project website. * **Public and Private Tool Segmentation**: Projects can choose to expose only selected tools to the public while restricting others to registered team members. For instance, the [Geospatial Explorer](./geospatial_explorer.md) might be -made publicly available for data discovery, while the collaborative [JupyterLab](./app_jupyterlab.md) remains limited to project members. +made publicly available for data discovery, while the collaborative [JupyterLab](./app_jupyterlab.md) remains limited to +project members. By thoughtfully providing access to the APEx instantiated services, projects can create a rich, interactive, and secure environment that supports ongoing collaboration, knowledge sharing, and engagement with both internal and external audiences. diff --git a/instantiation/project_portal.md b/instantiation/project_portal.md index 57847cf..80a0508 100644 --- a/instantiation/project_portal.md +++ b/instantiation/project_portal.md @@ -66,11 +66,16 @@ for detailed customization. @tbl-portal-examples showcases example projects that use the APEx Project Web Portal: -| Project | URL | -| :------------------------------ | :------------------------------------------------------- | -| APEx | [https://apex.esa.int/](https://apex.esa.int/) | -| APEx (Demo) | [https://demo.apex.esa.int/](https://demo.apex.esa.int/) | -| World Ecosystem Extent Dynamics | [https://esa-worldecosystems.org/](https://esa-worldecosystems.org/) | +| Project | URL | +| :------------------------------ | :----------------------------------------------------------------------------------- | +| APEx | [https://apex.esa.int/](https://apex.esa.int/) | +| APEx (Demo) | [https://demo.apex.esa.int/](https://demo.apex.esa.int/) | +| World Ecosystem Extent Dynamics | [https://esa-worldecosystems.org/](https://esa-worldecosystems.org/) | +| EO4SEM | [https://eo4sem.apex.esa.int/en](https://eo4sem.apex.esa.int/en) | +| EOBPs – Solar Energy | [https://eobp-energy.apex.esa.int/en](https://eobp-energy.apex.esa.int/en) | +| EOBPs – Health | [https://eobp-health.apex.esa.int/en/home](https://eobp-health.apex.esa.int/en/home) | +| EOBPs- Road and Rail | [https://eobp-transport.apex.esa.int/en](https://eobp-transport.apex.esa.int/en) | +| RAVE | [https://rave.apex.esa.int/en](https://rave.apex.esa.int/en) | : APEx Project Web Portal - Project Examples {#tbl-portal-examples}{tbl-colwidths="[30,70]"} diff --git a/instantiation/usecases.qmd b/instantiation/usecases.qmd index d73ff81..9a7e086 100644 --- a/instantiation/usecases.qmd +++ b/instantiation/usecases.qmd @@ -7,9 +7,9 @@ promotion and user support to data visualisation, data analytics, and data proce configurable environments, these services facilitate the effective sharing, maintenance, and utilisation of project results, ensuring they remain readily accessible and usable for extended periods. -This section provides an initial outline of the primary use cases for APEx Project Environments, demonstrating how they address -the specific needs and challenges faced by users and project managers in the EO domain. Each use case highlights the -relevant components of the APEx tools, detailing how they work together to provide robust solutions for various tasks. +This section provides an initial outline of the primary use cases for APEx Project Environments, demonstrating how they +address the specific needs and challenges faced by users and project managers in the EO domain. Each use case highlights +the relevant components of the APEx tools, detailing how they work together to provide robust solutions for various tasks. From promoting EO projects through interactive portals to supporting users with personalised workspaces and comprehensive documentation, the APEx Project Environments are designed to enhance productivity and foster collaboration. diff --git a/instantiation/user_workspace_finder.md b/instantiation/user_workspace_finder.md index 35d803b..06891bd 100644 --- a/instantiation/user_workspace_finder.md +++ b/instantiation/user_workspace_finder.md @@ -5,7 +5,7 @@ title: User Workspace Finder ## User Workspace Finder Overview The User Workspace Finder service within the APEx Project Environments provides secure, personalised environments for individual -users to perform a range of data management and data sharing tasks. +users to perform a range of data management and data sharing tasks. It is designed to provide the following key benefits to users when accessing their instance: @@ -39,19 +39,46 @@ observation tasks. * **Robust data management:**\Secure, persistent storage and retrieval of data using PersistentVolumeClaims (PVCs), along with data management tools, connectivity to external data sources, and data sharing mechanisms. -## User Workspace Finder showcase scenarios +## Showcase Scenarios -The User Workspaces Finder support a variety of use cases, making them versatile tools for the EO community. +The User Workspaces Finder support a variety of use cases, making them versatile tools for the EO community. Some typical scenarios include: +### ApplicationHub Showcase Scenarios + +The ApplicationHub provides access to platforms and web apps in a Software-as-a-Service mode. Users can engage with +containerised Interactive Graphical Applications (IGAs), specialised geospatial data exploration web apps, and customizable +dashboards. This allows users not only to explore and analyse results but also to execute new applications or analyses and +customise their computing experiences, all accessed from the same integrated Hub interface. + * **Development and Testing**\ Researchers and developers can use the User Workspace Finder to organise and share EOAP files under work within a team. * **Data Analysis and Visualisation**\ - Analysts can manage and perform data sharing of their Jupyter Notebook files, climate datasets and data analysis result files. + Analysts can manage and perform data sharing of their Jupyter Notebook files, climate datasets and data analysis result + files. * **Educational and Training Purposes**\ - Users can curate and share tutorials, for example related to various aspects of APEx, from setting up workspaces and accessing data in the Product Catalogue to using the IDE for development tasks. + Users can curate and share tutorials, for example related to various aspects of APEx, from setting up workspaces and + accessing data in the Product Catalogue to using the IDE for development tasks. + +### Workspace UI Showcase Scenarios + +The Workspace UI allows a Workspace user to invite additional members, create new buckets for sharing data or for temporary +scratch storage, manage access to their own buckets (granting or revoking permissions), and request access to other shared +buckets. + +* **Secure Collaboration**\ + Built-in Keycloak integration ensures unified authentication and fine-grained access control. Workspace owners can curate + the project space, invite collaborators, organize buckets and define how data is shared by granting or revoking access + permissions as needed. + + Upcoming releases will introduce vended credentials for scoped, time-limited access tokens. + +* **Cross-workspace collaboration**\ + Users can browse and read from the UI the curated objects in the shared bucket from other Workspace owners, without + duplicating data. Conversely, users can browse and organise their own datasets, and generate secure share links directly + from the browser. :::{.callout-tip} diff --git a/propagation/images/catalogue_details.png b/propagation/images/catalogue_details.png new file mode 100644 index 0000000..da64b79 Binary files /dev/null and b/propagation/images/catalogue_details.png differ diff --git a/propagation/onboarding.md b/propagation/onboarding.md index 5320ca2..3250f26 100644 --- a/propagation/onboarding.md +++ b/propagation/onboarding.md @@ -48,7 +48,9 @@ Through comprehensive guidelines and documentation, projects can seamlessly inte APEx [Algorithm Catalogue](https://algorithm-catalogue.apex.esa.int/). This process facilitates easy browsing and access to available algorithms, fostering collaboration and innovation within the EO community. -![APEx Algorithm Catalogue](images/catalogue.png) +![APEx Algorithm Catalogue - Overview](images/catalogue.png) + +![APEx Algorithm Catalogue - Details ](images/catalogue_details.png) The APEx [Algorithm Catalogue](https://algorithm-catalogue.apex.esa.int/) allows visitors to discover and select algorithms for subsequent execution on the corresponding APEx-compliant hosting environment. @@ -127,11 +129,14 @@ assistance in selecting a suitable platform, refer to the [Hosting Platform Onboarding Support](#hosting-platform-onboarding-support) section. 2. **Prepare Your Algorithm Record**: Create a detailed record of your algorithm service, including its functionalities, input/output specifications, and any relevant metadata. This record should adhere to the guidelines provided in our -[guide](../guides/algorithm_services_catalogue.qmd) -3. **Submit a Pull Request**: To officially onboard your algorithm service, submit a pull request (PR) to the +[guide](../guides/algorithm_services_catalogue.qmd). +3. **Establish Benchmark Scenarios**: APEx facilitates automated testing of your service. +Comprehensive guidance on developing benchmark scenarios can be found in our dedicated +[guide](../guides/algorithm_services_catalogue_benchmarks.qmd). +4. **Submit a Pull Request**: To officially onboard your algorithm service, submit a pull request (PR) to the [APEx Algorithms GitHub Repository](https://github.com/ESA-APEx/apex_algorithms). -4. **Review and Approval**: The APEx team will review your submission. If everything is in order, your algorithm service +5. **Review and Approval**: The APEx team will review your submission. If everything is in order, your algorithm service will be approved and added to the catalogue. -5. **Catalogue Integration**: Once approved, your algorithm service will be listed in the +6. **Catalogue Integration**: Once approved, your algorithm service will be listed in the [APEx Algorithm Catalogue](https://algorithm-catalogue.apex.esa.int/), making it accessible to the EO community. diff --git a/propagation/porting.md b/propagation/porting.md index 3540668..b175fb1 100644 --- a/propagation/porting.md +++ b/propagation/porting.md @@ -47,7 +47,7 @@ existing workflow to ensuring it can be executed within an APEx-compatible EO pl ### Packaging Your Algorithm as an OGC Application Package Alternatively, for existing pieces of complex software that need to be made available as a service, APEx offers support -for packaging it as an OGC Application Package. Leveraging time-limited expert consultations, this process adheres to +for packaging it as an Application Package. Leveraging time-limited expert consultations, this process adheres to the Best Practices for Earth Observation Application Packaging, as defined by the Open Geospatial Consortium (OGC) and the EO Exploitation Platform Common Architecture (EOEPCA), championed by the European Space Agency (ESA). These practices ensure that EO applications are reproducible and portable across diverse execution environments. diff --git a/propagation/upscaling.md b/propagation/upscaling.md index 2ad62d7..6082c84 100644 --- a/propagation/upscaling.md +++ b/propagation/upscaling.md @@ -37,7 +37,7 @@ approach to ensure that user requirements are fully addressed while ensuring the technologies and platforms. The goal is to abstract the underlying complexities, providing users with a simplified and efficient way of executing upscaling tasks. -APEx will start with establishing a formal procedure, supported by the APEx portal, to gather in a structured way the +APEx will start by establishing a formal procedure, supported by the APEx portal, to gather in a structured way the upscaling requirements from ESA projects. These requirements will serve as inputs for the consortium to prepare the environment for the upscaling activities. This includes configuring a tailored environment and the pre-configuration of the job orchestration tools that enable a simplified execution of upscaling tasks. @@ -46,11 +46,11 @@ In the subsequent phase, the consortium will rely on the previously implemented to the user experience by further automating the process. For the openEO-powered platforms, users of the APEx upscaling service currently have access to the following client tools, -that will be pre-configured for them by the APEx Upscaling team, based on the provided ESA project requirements: +which will be pre-configured for them by the APEx Upscaling team, based on the provided ESA project requirements: * An openEO batch job manager (Python library), which supports the creation of large-scale processing tasks for openEO developers by dividing them into separate batch jobs that can be automatically monitored. The openEO batch job manager -is built on top of the openEO API and can therefore be used independently from the underlying platform. +is built on top of the openEO API and can therefore be used independently of the underlying platform. During the following phase of APEx, the range of openEO client tools and their usability will be further enhanced to better support comprehensive upscaling activities. @@ -59,7 +59,7 @@ For the Application Package compatible platforms, users of the APEx upscaling se client tools that will be pre-configured for them by the APEx Upscaling team, based on the provided ESA project requirements: * An Application Package / OGC API Process systematic processing manager (Python library), which supports the creation -of large-scale processing tasks for Application Package users having technical skills to run such tool. The systematic +of large-scale processing tasks for Application Package users who have the technical skills to run such a tool. The systematic processing job manager is built on top of the OGC API Process standard interface and can, therefore, be used to communicate with the underlying compatible platform.