You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,21 @@
1
-
# CERIF XXX Module
2
-
Basic domain description of the module
1
+
# CERIF Instruments Module
2
+
This module contains classes and properties for modeling scientific instruments.
3
3
4
4
## Status
5
-
(2026-03-05) Experimental.
5
+
(2026-03-12) Work in progress.
6
6
7
7
## Overview
8
-
8
+
Instruments – or more specifically [Instrument Instances](./entities/Instrument_Instance.md) – are [Infrastructure](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Infrastructure.md).
9
+
Instrument instances can have information about their [models](./entities/Instrument_Model.md): several instrument instances can share a single model information record.
9
10
10
11
## Listings
11
12
12
13
### Entities
13
-
The XXX Module consists of the following entities:
14
-
*[XXX entity](./entities/XXX.md)
14
+
The Instruments Module consists of the following entities:
15
+
*[Resource](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Resource.md) (imported from [the CERIF Core](https://github.com/EuroCRIS/CERIF-Core))
16
+
*[Infrastructure](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Infrastructure.md) (imported from [the CERIF Core](https://github.com/EuroCRIS/CERIF-Core))
None besides those of [Infrastructure](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Infrastructure.md).
14
+
15
+
## Relationships
16
+
Besides those of [Infrastructure](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Infrastructure.md):
17
+
18
+
<aname="rel__is-instance-of">is-instance-of</a> / [has-instance](../entities/Instrument_Model.md#user-content-rel__has-instance) : An Instrument_Instance is an instance of a particular [Instrument_Models](../entities/Instrument_Model.md).
19
+
20
+
## Constraints
21
+
Any constraints a subclass makes on its superclasses.
22
+
23
+
## Illustrative Diagram
24
+
A UML diagram showing this entity in its context if one is available.
None besides those of [Infrastructure](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Infrastructure.md).
14
+
15
+
## Relationships
16
+
Besides those of [Infrastructure](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Infrastructure.md):
17
+
18
+
<aname="rel__has-instance">has-instance</a> / [is-instance-of](../entities/Instrument_Instance.md#user-content-rel__is-instance-of) : An Instrument_Model can have any number of [Instrument_Instances](../entities/Instrument_Instance.md).
19
+
20
+
## Constraints
21
+
Any constraints a subclass makes on its superclasses.
22
+
23
+
## Illustrative Diagram
24
+
A UML diagram showing this entity in its context if one is available.
0 commit comments