Update CITATION.cff and pyproject.toml files (#98)

* Added abstract and changed name Added an abstract to the CITATION.cff file Changed the name to NOMAD Material Processing Plugin in the CITATION.cff file and the docs * Updated maintainer and authors in toml Removed personal email addresses and added the general fairmat one
FAIRmat-NFDI · Sep 19, 2024 · 7c7cfcd · 7c7cfcd
1 parent 33f1ec9
commit 7c7cfcd
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 18 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -1,5 +1,5 @@
 cff-version: 1.2.0
-title: nomad-material-processing
+title: NOMAD Material Processing Plugin
 message: >-
   If you use this software, please cite it using the
   metadata from this file.
@@ -31,6 +31,13 @@ doi: 10.5281/zenodo.13786015
 repository-code: 'https://github.com/FAIRmat-NFDI/nomad-material-processing'
 url: 'https://fairmat-nfdi.github.io/nomad-material-processing/'
 abstract: >-
-  A NOMAD plugin containing base sections for material
-  processing.
+  `nomad-material-processing` is a plugin for the NOMAD software (https://zenodo.org/doi/10.5281/zenodo.8366162)
+  adding data schemas and parsers for material processing data.
+  For example, it can be used to store process data from various vapor deposition techniques,
+  such as metal-organic vapor phase epitaxy (MOVPE) or pulsed laser deposition (PLD),
+  into a common data format that can be analyzed, explored, and published in NOMAD.
+  The plugin is community driven and primarily aims at providing usability to users
+  through practical data parsers and common data schemas.
+  The data schemas continue to develop with the community to ultimately provide Findable,
+  Accessible, Interoperable, and Reusable (FAIR) data.
 license: Apache-2.0
diff --git a/docs/explanation/levelsofschema.md b/docs/explanation/levelsofschema.md
@@ -17,7 +17,7 @@ Every entry in NOMAD must inherit from `EntryData`, whenever a class is only use
 
 
 1. **Community/Standard Plugins**: FAIRmat offers standardized schemas for common methods, processes, and instruments that are generalized and not tied to any individual lab or setup. These schemas are derived from recurring patterns identified across user schemas. Users can inherit from these standard plugins in a similar manner as the base sections, further specializing them as needed while still maintaining a consistent structure for broader community use.
-FAIRmat's Area A for synthesis data provides two community plugins, NOMAD Measurements and NOMAD Materials Processing.
+FAIRmat's Area A for synthesis data provides two community plugins, NOMAD Measurements and NOMAD Material Processing.
 
 1. **User Defined Sections**: These schemas are developed by users and are tailored for a method or an instrument, a lab, or a research institute. They build upon the base sections and community plugins, tailoring them to meet specific research needs. In this level, users can define more specialized structures that directly reflect the unique characteristics of their experiments or simulations.
 

diff --git a/docs/how_to/develop.md b/docs/how_to/develop.md
@@ -1,6 +1,6 @@
 # How to Contribute to the NOMAD-material-processing Plugin
 
-The **NOMAD-material-processing plugin** is a community-driven effort aimed at providing shared data schemas, readers, and parsers for materials processing data. We encourage contributions from all users to help enhance and expand the plugin, making it more robust and broadly applicable. If you have any questions or need assistance, feel free to [contact us](../contact.md) — we’re here to help you get involved!
+The **NOMAD Material Processing Plugin** is a community-driven effort aimed at providing shared data schemas, readers, and parsers for material processing data. We encourage contributions from all users to help enhance and expand the plugin, making it more robust and broadly applicable. If you have any questions or need assistance, feel free to [contact us](../contact.md) — we’re here to help you get involved!
 
 Here’s how you can contribute:
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,10 +1,10 @@
-# Welcome to the NOMAD-materials-processing Plugin Documentation
+# Welcome to the NOMAD Material Processing Plugin Documentation
 
-Welcome to the official documentation for the **NOMAD-materials-processing Plugin**! This plugin provides NOMAD schemas, readers, and parsers for data of materials science synthesis processes in alignment with the FAIR (Findable, Accessible, Interoperable, and Reusable) principles. It serves as a community or standard plugin, offering commonly used schemas and classes/sections for materials processing data that can be shared across a community.
+Welcome to the official documentation for the **NOMAD Material Processing Plugin**! This plugin provides NOMAD schemas, readers, and parsers for data of materials science synthesis processes in alignment with the FAIR (Findable, Accessible, Interoperable, and Reusable) principles. It serves as a community or standard plugin, offering commonly used schemas and classes/sections for material processing data that can be shared across a community.
 
-## Supported Materials Processing Techniques
+## Supported Material Processing Techniques
 
-Currently, this plugin supports the following materials processing techniques:
+Currently, this plugin supports the following material processing techniques:
 
 - **Synthesis from Gas Phase**:
   Supports different *Vapor Deposition* methods:
@@ -23,16 +23,16 @@ Currently, this plugin supports the following materials processing techniques:
 - **Synthesis from Solution**:
   Supports Solution Preparation
 
-Additional materials processing techniques are actively being developed and will be included soon, including Synthesis from the Melt (bulk crystal growth), Synthesis by Assembly (e.g. polymerization).
+Additional material processing techniques are actively being developed and will be included soon, including Synthesis from the Melt (bulk crystal growth), Synthesis by Assembly (e.g. polymerization).
 
 Stay tuned for updates as more methods become available!
 
 ## What You Will Find in This Documentation
 
 This documentation builds upon the general [NOMAD documentation](https://nomad-lab.eu/prod/v1/staging/docs/explanation/data.html). Here, you will find comprehensive guides on:
 
-- **Using the Plugin**: Step-by-step instructions on how to integrate and use the NOMAD Materials Processing Plugin in your NOMAD Oasis.
-- **Data Structures and Supported Methods**: Detailed descriptions of the available schemas, sections, and supported materials processing techniques.
+- **Using the Plugin**: Step-by-step instructions on how to integrate and use the NOMAD Material Processing Plugin in your NOMAD Oasis.
+- **Data Structures and Supported Methods**: Detailed descriptions of the available schemas, sections, and supported material processing techniques.
 - **Contributing**: Learn how you can contribute to the ongoing development of this plugin.
 
 ## About NOMAD

diff --git a/docs/tutorial/tutorial.md b/docs/tutorial/tutorial.md
@@ -1,4 +1,4 @@
-There is no specific tutorial available for the **NOMAD-material-processing plugin** at the moment. However, to learn more about related topics, we encourage you to explore the **FAIRmat Tutorial series**. These tutorials cover a wide range of topics related to data management, materials processing, and the principles of the FAIR (Findable, Accessible, Interoperable, and Reusable) approach.
+There is no specific tutorial available for the **NOMAD-material-processing plugin** at the moment. However, to learn more about related topics, we encourage you to explore the **FAIRmat Tutorial series**. These tutorials cover a wide range of topics related to data management, material processing, and the principles of the FAIR (Findable, Accessible, Interoperable, and Reusable) approach.
 
 The FAIRmat tutorials will provide you with valuable insights into how to manage and structure materials data in NOMAD and how to contribute to community efforts like this plugin. Stay tuned for future updates, as specific tutorials for this plugin may be developed.
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -21,14 +21,18 @@ dynamic = ["version"]
 description = "A plugin for NOMAD containing base sections for material processing."
 readme = "README.md"
 authors = [
-    { name = "Andrea Albino", email = '[email protected]' },
-    { name = "Sebastian Brückner", email = '[email protected]' },
+    { name = "Andrea Albino" },
+    { name = "Sebastian Brückner" },
     { name = "Michael Götte" },
     { name = "Ahmed Ilyas" },
-    { name = "Sarthak Kapoor", email = '[email protected]' },
-    { name = "José A. Márquez", email = '[email protected]' },
-    { name = "Hampus Näsström", email = '[email protected]' },
+    { name = "Sarthak Kapoor" },
+    { name = "José A. Márquez" },
+    { name = "Hampus Näsström" },
     { name = "Markus Scheidgen" },
+    { email = "[email protected]" },
+]
+maintainers = [
+    { name = "FAIRmat", email = "[email protected]" },
 ]
 license = { file = "LICENSE" }
 dependencies = [