Skip to content

Commit 7258387

Browse files
committed
Add overview diagram
1 parent 70f9fae commit 7258387

2 files changed

Lines changed: 29 additions & 3 deletions

File tree

163 KB
Loading

documentation/dev/overview.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,39 @@ permalink: /documentation/dev/overview
77
<!-- Show the current active documentation page -->
88
{% include documentationStepper/stepper.html %}
99

10-
## Overview
10+
## High-level Overview
1111

12-
In this section of the website you will find the documentation for the development of the OpenEM components.
12+
The following diagram shows the components involved in OpenEM and a (simplified) view of typical interactions between them.
13+
14+
![OpenEM Components](/assets/img/documentation/dev/components.drawio.png)
15+
*Green: Newly developed components; Blue: Modified existing components; Grey: Newly deployed third-party components; Orange: External components*
16+
17+
{: .box-note}
18+
For simplicity, interactions regarding authentication flow are omitted. Please refer to the [Ingestor](https://github.com/SwissOpenEM/Ingestor) for a detailed description.
19+
20+
{: .box-note}
21+
For a detailed view of the situation at ETHZ, please refer to the documentation of the [ETHZ Archiving Service](https://www.openem.ch/ScopeMArchiver/).
22+
23+
## Open Source Projects
24+
25+
For detailed instructions and documentation of the individual components, refer to the respective repositories.
26+
27+
| Project | Link |
28+
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------|
29+
| Ingestor | [https://github.com/SwissOpenEM/Ingestor](https://github.com/SwissOpenEM/Ingestor) |
30+
| Depositor | [https://github.com/SwissOpenEM/Depositor](https://github.com/SwissOpenEM/Depositor) |
31+
| SciCat Frontend | [https://github.com/SwissOpenEM/scicat-frontend](https://github.com/SwissOpenEM/scicat-frontend) |
32+
| SciCat Backend | [https://github.com/SciCatProject/scicat-backend-next](https://github.com/SciCatProject/scicat-backend-next) |
33+
| SciCat CLI | [https://github.com/paulscherrerinstitute/scicat-cli](https://github.com/paulscherrerinstitute/scicat-cli) |
34+
| ETHZ Archiving Services | [https://github.com/SwissOpenEM/ScopeMArchiver](https://github.com/SwissOpenEM/ScopeMArchiver) |
35+
| Golang Globus transfer library | [https://github.com/SwissOpenEM/globus-transfer-request](https://github.com/SwissOpenEM/globus-transfer-request) |
36+
| Metadata Extraction - Life Sciences | [https://github.com/SwissOpenEM/LS_Metadata_reader](https://github.com/SwissOpenEM/LS_Metadata_reader) |
37+
| Metadata Extraction - Material Sciences | [https://github.com/SwissOpenEM/MS_Metadata_reader](https://github.com/SwissOpenEM/MS_Metadata_reader) |
38+
| OSC-EM format converters | [https://github.com/osc-em/converter-JSON-to-mmCIF](https://github.com/osc-em/converter-JSON-to-mmCIF) |
39+
| OSC-EM Schema | [https://github.com/osc-em/OSCEM_Schemas](https://github.com/osc-em/OSCEM_Schemas) |
1340

1441
### External links
1542

16-
- [SwissOpenEm Projects](/outreach#opensourceprojects)
1743
- [SciCat Development Guide](https://scicatproject.github.io/documentation/Development/)
1844

1945
<!-- Jump to next page -->

0 commit comments

Comments
 (0)