Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions guides/project_portal/index.qmd
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
title: Project Portal
title: Project Web Portal
listing:
contents: "tutorials"
type: "grid"
sort: 'filename'
filter-ui: true
---

Welcome to the user guide for the [APEx Project Portal](../../instantiation/project_portal.md), a powerful tool designed
Welcome to the user guide for the [APEx Project Web Portal](../../instantiation/project_portal.md), a powerful tool designed
to support your project communication.

In this user guide, you will find essential information and resources tailored to help you navigate the portal efficiently.
For a more general overview, we encourage you to explore the documentation available for the
[APEx Project Portal](../../instantiation/project_portal.md) and its [use cases](../../instantiation/usecases.qmd), where
[APEx Project Web Portal](../../instantiation/project_portal.md) and its [use cases](../../instantiation/usecases.qmd), where
you will discover how you can effectively use it within your project.

This user manual is designed for web managers and editors responsible for setting up, editing, and maintaining their project
website. It provides you with a list of tutorials that focus on the most common tasks you may encounter while using the APEx
Project Portal. Whether you are a newcomer or an experienced user, these tutorials will empower you to utilize the tool to
Project Web Portal. Whether you are a newcomer or an experienced user, these tutorials will empower you to utilize the tool to
its fullest potential.

Furthermore, as the portal is built on the [Drupal](https://new.drupal.org/home) framework, we recommend checking the
Expand Down
4 changes: 2 additions & 2 deletions guides/project_portal/tutorials/1_login.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Login to the Project Portal and the Drupal content overview"
title: "Login to the Project Web Portal and the Drupal content overview"
image: ../images/cover_login.png
lightbox: true
---
Expand Down Expand Up @@ -32,7 +32,7 @@ can manage:
:::
::: {.g-col-4}

![Project Portal login screen](../images/login_1.png){group="gallery-login"}
![Project Web Portal login screen](../images/login_1.png){group="gallery-login"}

![APEx login screen](../images/login_2.jpg){group="gallery-login"}

Expand Down
2 changes: 1 addition & 1 deletion guides/project_portal/tutorials/3c_news.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ image: ../images/cover_news.png
lightbox: true
---

The project portal allows you to add news items and an overview of all news items. The overview can be implemented via a
The Project Web Portal allows you to add news items and an overview of all news items. The overview can be implemented via a
separate web page or you can also add a **news** paragraph on any web page to list the latest news items for example.

## Add a news item
Expand Down
2 changes: 1 addition & 1 deletion guides/project_portal/tutorials/4_menu.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Via the main navigation overview, which you can access when you navigate to **st
administration toolbar, you can easily disable or enable main navigation (sub)menu items. Select the **Enabled** check to
show the menu item in the main navigation or deselect the **Enabled** checkbox to hide the menu item in the main navigation.

## Edit the name of your project portal
## Edit the name of your Project Web Portal

Upon instantiation of your project web portal, the name of your project will be set to display in the top left corner in
the header section, left from the main menu navigation, and in the footer. The acronym and/or full name will use the primary
Expand Down
12 changes: 8 additions & 4 deletions instantiation/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,18 @@ title: Accessing your environment

Each instantiated component is assigned a dedicated URL following the convention:

`https://<tool>.<project>.apex.esa.int.`
`https://<tool>.<project>.apex.esa.int`

The only exception to this rule is the project web portal, which is hosted at:

`https://<project>.apex.esa.int`

This URL assignment process is fully automated by APEx, including the generation of the necessary security certificates.
For example, if a project named `project-a` requests the instantiation of a user forum and a project portal, the following
For example, if a project named `project-a` requests the instantiation of a user forum and a project web portal, the following
URLs will be created:

`https://project-a.apex.esa.int` – the project portal
`https://forum.project-a.apex.esa.int` – the project's user forum
* `https://project-a.apex.esa.int` – the project web portal
* `https://forum.project-a.apex.esa.int` – the project's user forum

This granular URL assignment ensures a clear separation between the different instantiated components, making them easy
to manage and access. Additionally, as these URLs are publicly accessible, projects can seamlessly integrate the components
Expand Down
14 changes: 6 additions & 8 deletions instantiation/app_code_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
title: Code Server IDE
---

Code Server Interactive Development Environment - Tailored User Workspace

## Code Server overview
## Overview

The Code Server Interactive Development Environment (IDE) capacity within the APEx Project Environments primarily leverages the power
of the [Code Server software (Visual Studio Code in the Cloud)](#code-server-software-architecture).
Expand All @@ -21,7 +19,7 @@ them to harness the computational power of remote servers.
Tailored specifically for EO tasks, this environment furnishes developers with an array of tools and libraries fine-tuned
for programming languages and productivity plugins or extensions.

## Code Server software architecture
## Software Architecture

The APEx Code Server solution is an Integrated Development Environment delivered as a cloud-based user workspace, tailored
to support the activities of Earth observation (EO) projects.
Expand Down Expand Up @@ -54,7 +52,7 @@ their local machine's hardware capabilities, enabling them to leverage the compu
Code Server serves as the core development environment, providing a powerful and flexible platform for coding and debugging,
allowing developers to harness server-side computational power while maintaining a familiar interface.

### Code Server key features
### Key Features

The APEx Code Server IDE includes several features that make it suitable for both individual researchers and teams
working on EO research and applications.
Expand All @@ -74,15 +72,15 @@ complemented by a vast repository of extensions for virtually any language or fi
Leverage integrated Git support, allowing team members to work on the same project by tracking changes and merging updates,
helping to keep the code organised while avoiding conflicting code changes.

## Code Server showcase scenarios
## Showcase Scenarios

The APEx Code Server IDE supports a variety of use cases, making it an essential tool for developers,
researchers, and data scientists within the EO community. Some typical scenarios include:

* **Algorithm Development and Testing**\
Researchers and developers can write, test, and debug new algorithms for processing
satellite imagery or other EO data. For instance, a user might develop a script to detect deforestation using
multi-temporal satellite images. To support the productivity of developers, the Code Server solution uses
multi-temporal satellite images. To support the productivity of developers, the Code Server solution uses
a mechanism of extensions. Code Server extensions are available from the Open VSX Registry.

::: {.callout-note}
Expand All @@ -98,7 +96,7 @@ leave the Code Server user interface
* [Edit](https://continue.dev/docs/edit/how-to-use-it) is a convenient way to modify code without leaving your current file
* [Actions](https://continue.dev/docs/actions/how-to-use-it) are shortcuts for common use cases.

This extension asks for API keys to use the models.
This extension asks for API keys to use the models.
This has been successfully tested and could be an option for the APEx use cases.
:::

Expand Down
18 changes: 8 additions & 10 deletions instantiation/app_jupyterlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
title: JupyterLab IDE
---

JupyterLab Interactive Development Environment - Tailored User Workspace

## JupyterLab overview
## Overview

The JupyterLab Interactive Development Environment (IDE) capacity within the APEx Project Environments primarily leverages the power
of the [JupyterLab](#jupyterlab-software-architecture) software.
Expand All @@ -21,12 +19,12 @@ them to harness the computational power of remote servers.
Tailored specifically for EO tasks, this environment furnishes developers with an array of tools and libraries fine-tuned
for programming languages and productivity plugins or extensions.

## JupyterLab software architecture
## Software Architecture

The JupyterLab setup encapsulates a web-based interactive development environment for Jupyter notebooks, code, and data.
It is the user interface for Project Jupyter, offering a flexible user interface and more features than the classic notebook
UI. It is a web application providing a development environment in which processing algorithms and services can be developed,
tested, and debugged.
tested, and debugged.

![The JupyterLab IDE in the current APEx workspaces offering ](images/applicationhub_jupyterlab.png)

Expand All @@ -35,7 +33,7 @@ Julia, R, Haskell, Ruby, and Python (via the IPython kernel). It seamlessly adap
developers to create, test, and deploy applications within isolated, replicable, and consistent environments, ensuring
consistent behaviour across development, staging, and production phases.

### JupyterLab key features
## Key Features

The APEx JupyterLab IDE includes several features that make it suitable for both individual researchers and teams
working on EO research and applications.
Expand All @@ -53,18 +51,18 @@ various levels of support.
Leverage integrated Git support, allowing team members to work on the same project by tracking changes and merging updates,
helping to keep the code organized while avoiding conflicting code changes.

## JupyterLab showcase scenarios
## Showcase Scenarios

The APEx JupyterLab IDE supports a variety of use cases, making it an essential tool for developers,
researchers, and data scientists within the EO community. Some typical scenarios include:

* **Algorithm Development and Testing**\
Researchers and developers can write, test, and debug new algorithms for processing
satellite imagery or other EO data. For instance, a user might develop a script to detect deforestation using
multi-temporal satellite images. To support the productivity of developers, both the JupyterLab solution use a mechanism of extensions.
multi-temporal satellite images. To support the productivity of developers, both the JupyterLab solution use a mechanism of extensions.

::: {.callout-note}
There is no GitHub Copilot extension available yet for JupyterLab.
There is no GitHub Copilot extension available yet for JupyterLab.

See the [Code Server IDE](./app_code_server.md) page for more details on CoPilot extensions.

Expand All @@ -86,7 +84,7 @@ working with notebooks, with its native support for data science, data visualisa

## Examples

@tbl-ide-examples showcases example projects that utilize the APEx JupyterLab IDE.
@tbl-ide-examples showcases example projects that utilize the APEx JupyterLab IDE.

It is important to note that a valid APEx account and permissions from the project are required to access an environment.

Expand Down
8 changes: 2 additions & 6 deletions instantiation/app_qgis.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: QGIS as a Remote Desktop
---

QGIS as a Remote Desktop - Tailored User Workspace

## Overview

The Geographic Information System capacity within the APEx Project Environments primarily leverages the power
Expand All @@ -18,16 +16,15 @@ tasks or needing access to a consistent development environment from various loc
The server-based nature ensures that users are not constrained by their local machine's hardware capabilities, allowing
them to harness the computational power of remote servers.


## QGIS software architecture
## Software Architecture

The APEx QGIS workspace is a fully-fledged Geographic Information System delivered as a cloud-based user workspace, tailored
to support the activities of Earth observation (EO) projects.

![QGIS on a Remote Desktop in the current APEx workspaces offering ](images/applicationhub_qgis.png)

Each QGIS workspace comes equipped with the free and open source software project hosted on QGIS.org association, as well
as with a private data products catalogue. These features empower developer users to edit and build EO-based mapping products
as with a private data products catalogue. These features empower developer users to edit and build EO-based mapping products
and geospatial workflows, accelerating project outcomes within a dedicated, tool-rich environment.

### Key Features
Expand All @@ -53,7 +50,6 @@ Store, manage, and share QGIS projects with the ability to connect to external d
Teams can work collaboratively on GIS projects, sharing data and resources in real-time. A group
of data scientists might collaboratively develop crop yields scenario maps based on various data inputs.


## Examples

Several examples are under development and will be added on this page.
Expand Down
14 changes: 7 additions & 7 deletions instantiation/catalog.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Product Catalogue enables projects to create their own SpatioTemporal Asset
comprehensive metadata collection for efficient organisation and discovery of geospatial data assets. This information
is presented in a user-friendly JSON format.

![APEx Product Catalogue](images/stac_browser_1.jpg)
![APEx Product Catalogue](images/stac_browser_1.png)

Instantiating a project-specific catalogue gives projects the freedom to use it for a range of purposes, from
experimental to operational use cases. Assets that are considered project deliverables will normally be added to the
Expand Down Expand Up @@ -48,15 +48,15 @@ The product catalogue serves several beneficial scenarios for projects:

### STAC Catalogue API

You will get a dedicated STAC catalog, hosted and managed by APEx. This gives you full control over the metadata,
You will get a dedicated STAC catalogue, hosted and managed by APEx. This gives you full control over the metadata,
without having to worry about IT aspects such as security, backup or monitoring the service. The catalogue supports
creating both private and public collections.

#### Key Considerations

* **Data storage**: The STAC catalogue does _not_ include data storage. It is recommended to request object storage access
* **Data storage**: The STAC catalogue does include limited data storage. It is recommended to request object storage access
from one of the cloud providers in the Network of Resources (NoR).
* M**etadata Creation**: The process of creating metadata is not automated. You will need to provide the metadata in
* **Metadata Creation**: The process of creating metadata is not automated. You will need to provide the metadata in
JSON
format, giving you complete flexibility in choosing the STAC extensions that best suit your requirements.

Expand All @@ -72,12 +72,12 @@ is not provided.
### STAC Browser

In addition to the STAC Catalogue API, APEx provides a dedicated STAC Browser to support the visual exploration of your
catalog's content. This browser is seamlessly integrated with the instantiated API and is automatically configured upon
catalogue's content. This browser is seamlessly integrated with the instantiated API and is automatically configured upon
initialization to display the results published in your STAC API.

![STAC Browser - Collections](images/stac_browser_1.jpg)
![STAC Browser - Collections](images/stac_browser_1.png)

![STAC Browser - Collection Details](images/stac_browser_2.jpg)
![STAC Browser - Collection Details](images/stac_browser_2.png)

#### Underlying Technology

Expand Down
4 changes: 2 additions & 2 deletions instantiation/documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ A documentation portal can support several project scenarios, including:

The APEx Documentation Portal Service provides users with a streamlined template to initiate their documentation process.
As changes are made, advanced automation tools ensure that the documentation is published seamlessly to a location that
integrates effortlessly within your project portal. This service is most effective when used in conjunction with the
[APEx Project Portal](./project_portal.md), maximizing the level of integration.
integrates effortlessly within your project web portal. This service is most effective when used in conjunction with the
[APEx Project Web Portal](./project_portal.md), maximizing the level of integration.

This documentation template includes the following features:

Expand Down
Binary file removed instantiation/images/stac_browser_1.jpg
Binary file not shown.
Binary file added instantiation/images/stac_browser_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed instantiation/images/stac_browser_2.jpg
Binary file not shown.
Binary file added instantiation/images/stac_browser_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading