OpenEM Development Manual¶
High-level overview¶
The following diagram shows the components involved in OpenEM and a (simplified) view of typical interactions between them.
Green: Newly developed components; Blue: Modified existing components; Grey: Newly deployed third-party components; Orange: External components.
Note
For simplicity, interactions regarding authentication are omitted. Refer to the Ingestor documentation for a detailed description.
Note
For a detailed view of the setup at ETH Zurich, refer to the documentation of the ETHZ Archiving Service.
Open-source projects¶
For detailed instructions and documentation of the individual components, refer to the respective repositories.
| Project | Link |
|---|---|
| Ingestor | https://github.com/SwissOpenEM/Ingestor |
| Depositor | https://github.com/SwissOpenEM/Depositor |
| SciCat Frontend | https://github.com/SwissOpenEM/scicat-frontend |
| SciCat Backend | https://github.com/SciCatProject/scicat-backend-next |
| SciCat CLI | https://github.com/paulscherrerinstitute/scicat-cli |
| ETHZ Archiving Services | https://github.com/SwissOpenEM/ScopeMArchiver |
| Golang Globus transfer library | https://github.com/SwissOpenEM/globus-transfer-request |
| Metadata Extraction - Life Sciences | https://github.com/SwissOpenEM/LS_Metadata_reader |
| Metadata Extraction - Material Sciences | https://github.com/SwissOpenEM/MS_Metadata_reader |
| OSC-EM format converters | https://github.com/osc-em/converter-JSON-to-mmCIF |
| OSC-EM Schema | https://github.com/osc-em/OSCEM_Schemas |