diff --git a/.gitignore b/.gitignore index 2042ded..1c5351b 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ venv* **/.ipynb_checkpoints **/figure-docx **.docx +.vscode diff --git a/_quarto.yml b/_quarto.yml index 5ffb815..877770e 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -34,7 +34,7 @@ website: - href: instantiation/index.md text: Project Tools contents: - - href: instantiation/usecases.md + - href: instantiation/usecases.qmd text: Use Cases - href: instantiation/geospatial_explorer.md - href: instantiation/project_portal.md diff --git a/css/components/_mermaid.scss b/css/components/_mermaid.scss index 92cc8da..1dc5ab9 100644 --- a/css/components/_mermaid.scss +++ b/css/components/_mermaid.scss @@ -36,10 +36,3 @@ $mermaid-label-bg-color: var(--white); color: var(--white) !important; } } - - -.cluster { - .cluster-label { - transform: translateX(20px) translateY(15px); - } -} diff --git a/instantiation/index.md b/instantiation/index.md index 5b6e264..fb5bfce 100644 --- a/instantiation/index.md +++ b/instantiation/index.md @@ -54,3 +54,5 @@ The specific components of the APEx Project Tools include: The APEx Project Tools will be essential for ensuring that the results of EO projects are effectively shared and utilised, fostering greater collaboration and innovation within the EO community. By providing robust, scalable, and user-friendly environments, the APEx Project Tools help maximise the impact of EO research and applications. + +Learn how the APEx Project Tools facilitate collaborative working environments for various [use cases](./usecases.qmd). diff --git a/instantiation/usecases.md b/instantiation/usecases.qmd similarity index 62% rename from instantiation/usecases.md rename to instantiation/usecases.qmd index e33559e..2c27f75 100644 --- a/instantiation/usecases.md +++ b/instantiation/usecases.qmd @@ -17,8 +17,16 @@ visualisation tools enable users to interpret and communicate insights effective environments provide the computational power and tools necessary for complex analyses. Data processing workflows are streamlined through secure, scalable environments, ensuring that users can handle large volumes of EO data efficiently. -The following use cases provide detailed scenarios of how the APEx Project Tools can be leveraged to meet the diverse -needs of the EO community, maximising the impact of EO research and applications. +It is important to highlight that the APEx Project Tools can be combined in different ways to create a flexible +collaborative project environments. This gives projects the flexibility to adapt the tools based on their needs. For +example, they can choose to make the project portal as their main entry point for both project members and their +community, linking to the different APEx tools from within the main website. Alternatevely, projects can decide to only +keep the project portal for public communication and dissimenation, while having the user workspaces only visible for +the project members. In essence, the APEx Project Tools provide an a la carte approach for setting up and configuring +your project environment based on your needs. + +To explore the possiblities, the following use cases provide detailed scenarios of how the APEx Project Tools can be +leveraged to meet the diverse needs of the EO community, maximising the impact of EO research and applications. ## Use Case 1 - Project Promotion @@ -40,6 +48,23 @@ including stakeholders, policymakers, and the general public. * [**User Forum**](forum.md)\ Supports community engagement and discussions around the project outcomes. +```{mermaid} +%%| label: fig-tools-usecase2 +%%| fig-cap: "APEx Project Tools - User Support" +flowchart TD "" + subgraph Public Environment + A(Project Portal) -->|Links to| B(Geospatial
Explorer) + A -->|Links to| C(Documentation
Portal) + A -->|Links to| D(User
Forum) + end + + class A,B,C,D apexService + click A href "./project_portal.html" _blank + click B href "./geospatial_explorer.html" _blank + click C href "./documentation.html" _blank + click D href "./forum.html" _blank +``` + ### Expected Benefits * Increased visibility and impact of EO projects. @@ -56,15 +81,38 @@ help, share knowledge, and collaborate on EO applications. ### Key Components -* [**User Workspace**](user_workspace.md)\ - Secure and personalised environments allow users to store, share, and manage their data and work. -* [**Interactive Development Environment (IDE)**](ide.md)\ - Leveraging VS Code Server, these environments are tailored for EO tasks and provide development tools. +* [**Project Portal**](project_portal.md)\ + Provides dynamic instantiation using Drupal, allowing project managers to create and maintain a visually appealing and + informative site. * [**User Forum**](forum.md)\ An on-demand service based on Discourse, facilitating user discussions, support queries, and community-driven solutions. * [**Documentation Portal**](documentation.qmd)\ Comprehensive documentation and tutorial materials to assist users in navigating and utilising the services. +* [**User Workspace**](user_workspace.md)\ + Secure and personalised environments allow users to store, share, and manage their data and work. +* [**Interactive Development Environment (IDE)**](ide.md)\ + Leveraging VS Code Server, these environments are tailored for EO tasks and provide development tools. + +```{mermaid} +%%| label: fig-tools-usecase2 +%%| fig-cap: "APEx Project Tools - User Support" +flowchart TD "" + subgraph Project Environment + UW(User Workspace) --> |Activate| IDE(Interactive Development
Environment) + end + subgraph Public Environment + A(Project Portal) -->|Links to| C(Documentation
Portal) + A -->|Links to| D(User
Forum) + end + + class UW,IDE,A,C,D apexService + click A href "./project_portal.html" _blank + click C href "./documentation.html" _blank + click D href "./forum.html" _blank + click UW href "./user_workspace.html" _blank + click IDE href "./ide.html" _blank +``` ### Expected Benefits @@ -89,6 +137,21 @@ project-specific visualisations, helping users to interpret and communicate data * [**Documentation Portal**](documentation.qmd)\ Interactive visualisations within documentation to explain data findings and methodologies. +```{mermaid} +%%| label: fig-tools-usecase3 +%%| fig-cap: "APEx Project Tools - Data Visualization" +flowchart TD "" + subgraph Public Environment + A(Project Portal) -->|Links to| B(Geospatial
Explorer) + A -->|Links to| C(Documentation
Portal) + end + + class A,B,C apexService + click A href "./project_portal.html" _blank + click B href "./geospatial_explorer.html" _blank + click C href "./documentation.html" _blank +``` + ### Expected Benefits * Enhanced understanding and interpretation of EO data. @@ -114,6 +177,29 @@ providing powerful tools and environments for data processing and statistical an * [**Geospatial Explorer**](geospatial_explorer.md)\ Integration with analytics tools to provide real-time visualisations of analytical results. +```{mermaid} +%%| label: fig-tools-usecase4 +%%| fig-cap: "APEx Project Tools - Data Analytics" +flowchart TD "" + subgraph Project Environment + UW(User Workspace) --> |Activate| IDE(Interactive Development
Environment) + end + subgraph Public Environment + A(Project Portal) -->|Links to| B(Geospatial
Explorer) + B -->|Visualizes| C(Product
Catalogue) + A -->|Links to| C + end + + IDE -->|Publish| C + + class UW,IDE,A,B,C apexService + click A href "./project_portal.html" _blank + click B href "./geospatial_explorer.html" _blank + click C href "./catalog.html" _blank + click UW href "./user_workspace.html" _blank + click IDE href "./ide.html" _blank +``` + ### Expected Benefits * Enhanced analytical capabilities and data-driven insights. @@ -139,6 +225,29 @@ Streamlined data ingestion and access to a wide range of EO datasets. * **[Geospatial Explorer](geospatial_explorer.md) and Web Apps**\ Interactively visualise results. +```{mermaid} +%%| label: fig-tools-usecase5 +%%| fig-cap: "APEx Project Tools - Data Processing" +flowchart TD "" + subgraph Project Environment + UW(User Workspace) --> |Activate| IDE(Interactive Development
Environment) + end + subgraph Public Environment + A(Project Portal) -->|Links to| B(Geospatial
Explorer) + B -->|Visualizes| C(Product
Catalogue) + A -->|Links to| C + end + + IDE -->|Publish| C + + class UW,IDE,A,B,C apexService + click A href "./project_portal.html" _blank + click B href "./geospatial_explorer.html" _blank + click C href "./catalog.html" _blank + click UW href "./user_workspace.html" _blank + click IDE href "./ide.html" _blank +``` + ### Expected Benefits * Improved efficiency in data processing workflows.