Skip to content

Commit 111bde1

Browse files
MarekSuchanekMarekSuchanek
committed
Use bibtex references
1 parent 37c6833 commit 111bde1

File tree

5 files changed

+92
-8
lines changed

5 files changed

+92
-8
lines changed

‎docs/architecture/fair_if.rst‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The FAIR Testing Interoperability Framework (FAIR-IF) uses, almost exclusively,
99
FAIR Reference Model Conceptual Components
1010
******************************************
1111

12-
Guided by the Compliance Assessment Toolkit [1], we have identified the set of distinct components that make up a FAIR testing environment. These, and the relationships between them, are diagrammed in Figure 1. These are categorised as Conceptual (shown in green), Software (blue), and Data (orange) levels. In addition, there is a higher level of Conceptual object we call a Dimension (red), which represents an established principle (e.g. FAIR Principle F1) that motivates the need for the creation of a FAIR test (or set of tests).
12+
Guided by the Compliance Assessment Toolkit :cite:`faircore4eosc_d2.2`, we have identified the set of distinct components that make up a FAIR testing environment. These, and the relationships between them, are diagrammed in Figure 1. These are categorised as Conceptual (shown in green), Software (blue), and Data (orange) levels. In addition, there is a higher level of Conceptual object we call a Dimension (red), which represents an established principle (e.g. FAIR Principle F1) that motivates the need for the creation of a FAIR test (or set of tests).
1313

1414
.. figure:: fair-if.png
1515

@@ -43,4 +43,11 @@ Additional information
4343
**********************
4444

4545
Check our deliverables for more information:
46-
* [1] van Lieshout, N., Buys, M., Zamani, T., Rijsselberg, F., & Märkälä, A. (2024). Compliance Assessment Toolkit: Deliverable 2.2 (W. Hugo & W. Steinhoff, Eds.). Zenodo. https://doi.org/10.5281/zenodo.12683218
46+
47+
.. bibliography::
48+
:list: bullet
49+
:filter: False
50+
:keyprefix: fair-if-
51+
:labelprefix: fair-if-
52+
53+
faircore4eosc_d2.2

‎docs/architecture/intro.rst‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Architecture
55
Tomasz Miksa
66

77

8-
The OSTrails reference architecture provides guidance on realising interactions between key components identified in the OSTrails pathways: Data Management Plans (DMPs), Scientific Knowledge Graphs (SKGs), and FAIR Assessment. It clarifies which interactions are standardised within the Interoperability Frameworks and which are relevant to the project without prescribing specific implementation methods. For example, while the reference architecture specifies when the DMP API (part of the DMP Interoperability Framework) must be used, it leaves the method of accessing information from data repositories flexible.
8+
The OSTrails reference architecture :cite:`ostrails_d1.4` :cite:`ostrails_d2.5` provides guidance on realising interactions between key components identified in the OSTrails pathways :cite:`ostrails_d1.1`: Data Management Plans (DMPs), Scientific Knowledge Graphs (SKGs), and FAIR Assessment. It clarifies which interactions are standardised within the Interoperability Frameworks and which are relevant to the project without prescribing specific implementation methods. For example, while the reference architecture specifies when the DMP API (part of the DMP Interoperability Framework) must be used, it leaves the method of accessing information from data repositories flexible.
99

1010
A key objective of this architecture is to prevent vendor lock-in, ensuring tools and services can be used interchangeably in typical scenarios outlined by the pathways. For instance, any SKG conforming to the SKG-IF can seamlessly integrate with DMP tools to provide additional insights into reused datasets. This architecture emphasises harmonising the modelling and exchange of information across research data management services while allowing diverse implementation choices tailored to specific use cases.
1111

@@ -44,7 +44,13 @@ Additional information
4444
**********************
4545

4646
Check our deliverables for more information:
47-
* Reichmann, S., Rey Mazón, M., Hasani-Mavriqi, I., Thaci, L., & Eckhard, D. (2024). **D1.1: Plan-Track-Assess Pathways**. Zenodo. https://doi.org/10.5281/zenodo.13145788
48-
* Miksa, T., Wilkinson, M., Manghi, P., & Suchánek, M. (2025). **D1.4 OSTrails Interoperability Reference Architecture V1**. Zenodo. https://doi.org/10.5281/zenodo.14795000
49-
* Suchánek, M., Martínková, J., Shepherdson, J., Miksa, T., Jirka, J., Knaisl, V., Moilanen, K., Sansone, S.-A., & Stavropoulos, T. (2025). **D2.5 OSTrails Commons Specifications**. Zenodo. https://doi.org/10.5281/zenodo.14795060
5047

48+
.. bibliography::
49+
:list: bullet
50+
:filter: False
51+
:keyprefix: architecture-intro-
52+
:labelprefix: architecture-intro-
53+
54+
ostrails_d1.4
55+
ostrails_d2.5
56+
ostrails_d1.1

‎docs/commons/intro.rst‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,22 @@ OSTrails Commons
66
Marek Suchánek
77

88

9-
The **OSTrails Commons** (referred to also as ‘the Commons’ hereafter) is formally defined as a **collection of open, reusable, and adaptable resources that collectively enable and enhance interoperability** within the OSTrails ecosystem and beyond. These resources are designed to lower adoption barriers to integration by standardising interactions between tools, ensuring alignment with the OSTrails Interoperability Framework (IF) and Reference Architecture (RA). The Commons is not standalone tools or services; rather, they provide the foundational elements that support and guide the development, operation, and evolution of interoperable research-supporting platforms. By bridging technical, semantic, and procedural gaps, the Commons facilitate collaboration and scalability while remaining flexible for adaptation to emerging technologies and diverse research contexts.
9+
The **OSTrails Commons** :cite:`ostrails_d2.5` (referred to also as ‘the Commons’ hereafter) is formally defined as a **collection of open, reusable, and adaptable resources that collectively enable and enhance interoperability** within the OSTrails ecosystem and beyond. These resources are designed to lower adoption barriers to integration by standardising interactions between tools, ensuring alignment with the OSTrails Interoperability Framework (IF) and Reference Architecture (RA) :cite:`ostrails_d1.4`. The Commons is not standalone tools or services; rather, they provide the foundational elements that support and guide the development, operation, and evolution of interoperable research-supporting platforms. By bridging technical, semantic, and procedural gaps, the Commons facilitate collaboration and scalability while remaining flexible for adaptation to emerging technologies and diverse research contexts.
1010

1111
The Commons is **built through iterative cycles**, where specifications will evolve (either individually or in synchrony with other components of The Commons) to **incorporate feedback from tool developers and other stakeholders**. This iterative approach ensures that the Commons remains practical and adaptable. For this reason, entities in the commons are carefully versioned, and versioned releases are generated as required to ensure that the tools work together.
1212

1313
The Commons is **guided by the Plan-Track-Assess Pathways defined by OSTrails**, which provides a map of how tools interact to facilitate research workflows. The pathways flow through three primary Interoperability Frameworks (IF): the SKG-IF, the DMP-IF, and the FAIR-IF. As such, this living repository is similarly split into three chapters with the same names, containing the detailed record of the members of that sub-set of Commons artefacts.
14+
15+
Additional information
16+
**********************
17+
18+
Check our deliverables for more information:
19+
20+
.. bibliography::
21+
:list: bullet
22+
:filter: False
23+
:keyprefix: commons-intro-
24+
:labelprefix: commons-intro-
25+
26+
ostrails_d2.5
27+
ostrails_d1.4

‎docs/other/resources.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ Resources
33

44
.. bibliography::
55
:all:
6-
:list: enumerated
6+
:style: plain

‎docs/references.bib‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
@misc{faircore4eosc_d2.2,
2+
author = {Hugo, Wim and
3+
Steinhoff, Wilko and
4+
Lieshout, Natascha and
5+
Buys, Matthew and
6+
Zamani, Themis and
7+
van Rijsselberg, Fjodor and
8+
Märkälä, Anu},
9+
title = {D2.2 – Compliance Assessment Toolkit},
10+
month = jul,
11+
year = 2024,
12+
publisher = {Zenodo},
13+
doi = {10.5281/zenodo.12683218},
14+
}
15+
16+
@misc{ostrails_d1.1,
17+
author = {Reichmann, Stefan and
18+
Rey Mazón, Miguel and
19+
Hasani-Mavriqi, Ilire and
20+
Thaci, Laura and
21+
Eckhard, David},
22+
title = {D1.1: Plan-Track-Assess Pathways},
23+
month = jul,
24+
year = 2024,
25+
publisher = {Zenodo},
26+
doi = {10.5281/zenodo.13145788},
27+
}
28+
29+
@misc{ostrails_d1.4,
30+
author = {Miksa, Tomasz and
31+
Wilkinson, Mark and
32+
Manghi, Paolo and
33+
Suchánek, Marek},
34+
title = {D1.4 OSTrails Interoperability Reference Architecture V1},
35+
month = jan,
36+
year = 2025,
37+
publisher = {Zenodo},
38+
doi = {10.5281/zenodo.14795000},
39+
}
40+
41+
@misc{ostrails_d2.5,
42+
author = {Suchánek, Marek and
43+
Martínková, Jana and
44+
Shepherdson, John and
45+
Miksa, Tomasz and
46+
Jirka, Jakub and
47+
Knaisl, Vojtěch and
48+
Moilanen, Katja and
49+
Sansone, Susanna-Assunta and
50+
Stavropoulos, Tassos},
51+
title = {D2.5 OSTrails Commons Specifications},
52+
month = jan,
53+
year = 2025,
54+
publisher = {Zenodo},
55+
doi = {10.5281/zenodo.14795060},
56+
}
57+

0 commit comments

Comments
 (0)