Skip to content

Commit ace3e86

Browse files
Update README.rst
Add: - Link to schema - Link to preprint
1 parent 886b2e7 commit ace3e86

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

README.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,17 @@ __________________________________________________________
55
|
66
| SMECS facilitates the extraction of research software metadata from GitHub and GitLab repositories. It provides a user-friendly graphical interface for visualizing the retrieved metadata, enabling researchers and research software engineers to create high-quality metadata without reentering information already available elsewhere. The curated metadata is exported as CodeMeta-compliant JSON, ensuring integration with other tools and enhancing the discoverability, reuse, and impact of research software.
77
|
8+
| 📄 For more details, see our `Preprint <http://doi.org/10.48550/arXiv.2507.18159>`_.
89
|
910
| **Authors:** Stephan Ferenz, Aida Jafarbigloo
1011
|
1112
Phases in SMECS
1213
__________________________________________________________
1314
| The workflow of SMECS consists of four sequential phases: **Start**, **Extraction**, **Curation**, and **Export**.
1415
|
15-
|
16-
1716
.. image:: https://github.com/NFDI4Energy/SMECS/blob/master/docs/Extraction_via_hermes-1.png
1817
:alt: SMECS Workflow
1918
:width: 1000px
20-
21-
|
2219
|
2320
2421
1. **Start Phase**
@@ -32,7 +29,7 @@ SMECS can operate without user-provided tokens for some repositories by using in
3229
|
3330
2. **Extraction Phase**
3431
__________________________________________________________
35-
The Extraction phase uses `HERMES <https://github.com/softwarepub/hermes>`_ harvesting steps to retrieve metadata from multiple sources. For details on the specific metadata fields, see: `Metadata Terms in SMECS <https://github.com/NFDI4Energy/SMECS/blob/master/docs/metadata-terms.md>`_. Once the inputs from the Start phase are submitted, SMECS initiates metadata retrieval using four HERMES harvesters:
32+
The Extraction phase uses `HERMES <https://github.com/softwarepub/hermes>`_ harvesting steps to retrieve metadata from multiple sources. For details on the metadata fields, see: `Metadata Terms in SMECS <https://github.com/NFDI4Energy/SMECS/blob/master/static/schema/codemeta_schema.json>`_. Once the inputs from the Start phase are submitted, SMECS initiates metadata retrieval using four HERMES harvesters:
3633
- GitHub
3734
- GitLab
3835
- CFF (`Citation File Format <https://citation-file-format.github.io/>`_)

0 commit comments

Comments
 (0)