diff --git a/docs/images/Logos.png b/docs/images/Logos.png new file mode 100644 index 0000000..c11627e Binary files /dev/null and b/docs/images/Logos.png differ diff --git a/docs/images/TOC figure from paper.png b/docs/images/TOC figure from paper.png new file mode 100644 index 0000000..ed4837f Binary files /dev/null and b/docs/images/TOC figure from paper.png differ diff --git a/docs/index.md b/docs/index.md index f1a1e98..c5d2591 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,52 @@ # Welcome to the `nomad-unisyscat` documentation -A example plugin for a demonstration for UniSysCat. +![Combined logos for NOMAD Oasis and UniSysCat](images/Logos.png) + +Welcome to the NOMAD Oasis demonstration! This documentation provides an overview of the example dataset, supported entry types, and details about the data and publications used in this demonstration. Our goal is to help UniSysCat users effectively manage and explore research data using NOMAD. + +This demonstration highlights [NOMAD Oasis](https://nomad-lab.eu/nomad-lab/nomad-oasis.html), a data management and sharing platform developed as part of the [FAIRmat](https://www.fairmat-nfdi.eu/fairmat/) project within the National Research Data Infrastructure ([NFDI](https://www.nfdi.de/)). NOMAD facilitates the collection, storage, analysis, and dissemination of research data, adhering to the principles of FAIR (Findable, Accessible, Interoperable, and Reusable) data management. + ## Introduction -!!! note "Attention" - TODO +This example demonstrates how NOMAD effectively manages diverse research data, particularly in computational and experimental research. It encompasses various entry types, showcasing NOMAD's flexibility and robust data integration features. + +The dataset used in this demonstration originates from a paper by C. Lorent *et al.* +[(Angew. Chem. Int. Ed. 2021, 60, 15854–15862)](doi.org/10.1002/anie.202100451). + +The paper introduces an innovative experimental setup for spectroscopic analyses of gas-converting metalloenzymes. It allows for adjustments in gas composition and temperature, enabling the preparation of specific redox states for characterization using complementary spectroscopic tools such as IR, EPR, or NRVS. + +![Alt text](images/TOC%20figure%20from%20paper.png) + + +This NOMAD Oasis demonstration illustrates the Research Data Management (RDM) of experiments focusing on the regulatory [NiFe]-hydrogenase from Ralstonia eutropha (ReRH). The experiments involve preparing the catalytic intermediate (Nia-C) using highly concentrated lyophilized samples of ReRH treated either in H2 or D2, followed by characterizing the sample via IR, Raman spectroscopy (RR), and Nuclear Resonance Vibrational Spectroscopy (NRVS). Additionally, it includes the calculation of vibrational frequencies. + +The demonstration covers creating entries for different parts of the experiment, uploading raw data files from measurements and calculations, visualizing them in NOMAD, and demonstrating how different project members can collaborate. + + +### **Supported Entry Types** +In this demonstration, NOMAD supports multiple entry types, including: + +1. **Experimental Data:** +- Tabular data files with the .dat file format. +- Binary data files with the .DSC file format. +- Electronic Lab Notebook (ELN) entries for samples, instruments, and processing, based on the NOMAD schema. + + +2. **Computational data:** +- Output files from Density Functional Theory (DFT) calculations based on the Gaussian 09 package. + +### **Research Data:** + +The data used in this NOMAD Oasis demonstration come from various sources, ensuring a comprehensive representation of the types of entries NOMAD can manage. The primary sources include: + +- In-situ Infrared (IR) spectroscopy for ReRH_Nia-C_H. +- 57Fe nuclear resonance vibrational spectroscopy (NRVS), both measured and simulated, for ReRH_Nia-C_H and ReRH_Nia-C_D. +- Electron paramagnetic spectroscopy (EPR) for ReRH_Nia-C_H. +- Density functional theory (DFT) calculations using the Gaussian package for ReRH_Nia-C_H and ReRH_Nia-C_D. + +By exploring this demonstration, users will gain a clearer understanding of how NOMAD can streamline research data management processes, enhance data quality, and foster collaboration across UniSysCat. +