Files
3cacf16dda
Build and deploy documentation / build-docs (push) Successful in 27s
Build and deploy documentation / deploy-docs (push) Successful in 29s
Add OpenEM documentation to the main website (#23)
Migrate documentation from https://www.openem.ch to https://data-catalog-services.pages.psi.ch.

This adds a new section for OpenEM documentation, focusing on topics specific to the electron microscopy community (the web ingestor, EMDB deposition, globus installation, etc). This should complement the more general information in the Ingestor Manual. It should be easier for users to find from scicat.

This branch was authored primarly by @dpwiessner on a [private fork](https://github.com/SwissOpenEM/gitea_documentation_update/tree/docu-refactoring).

---------

Co-authored-by: Spencer Bliven <spencer.bliven@gmail.com>
Co-authored-by: dpwiessner <david.wiessner@indema.ch>
Reviewed-on: #23
2026-09-30 22:58:53 +02:00

3.1 KiB

title, description
title description
Development Manual Technical overview and source repositories for OpenEM developers.

OpenEM Development Manual

High-level overview

The following diagram shows the components involved in OpenEM and a (simplified) view of typical interactions between them.

OpenEM components

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