Skip to content

Commit 871c2a8

Browse files
committed
Sketch of the two main entities
1 parent d18b745 commit 871c2a8

3 files changed

Lines changed: 72 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff 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.
33

44
## Status
5-
(2026-03-05) Experimental.
5+
(2026-03-12) Work in progress.
66

77
## 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.
910

1011
## Listings
1112

1213
### 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))
17+
* [Instrument Instance](./entities/Instrument_Instance.md)
18+
* [Instrument Model](./entities/Instrument_Model.md)
1519

1620
### Data Types
1721
* [XXX data type](./datatypes/XXX.md)

entities/Instrument_Instance.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Instrument_Instance
2+
3+
## Definition
4+
The scope of the entity and its meaning.<sup>[1](#fn1)</sup>
5+
6+
## Usage notes
7+
An additional description to communicate the purpose of the entity.
8+
9+
## Specialization of
10+
[Infrastructure](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Infrastructure.md)
11+
12+
## Attributes
13+
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+
<a name="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.
25+
26+
---
27+
## Matches
28+
1. Close match of [whatever](url)
29+
30+
## References
31+
<a name="fn1">\[1\]</a> Source: ...

entities/Instrument_Model.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Instrument_Model
2+
3+
## Definition
4+
The scope of the entity and its meaning.<sup>[1](#fn1)</sup>
5+
6+
## Usage notes
7+
An additional description to communicate the purpose of the entity.
8+
9+
## Specialization of
10+
[Infrastructure](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Infrastructure.md)
11+
12+
## Attributes
13+
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+
<a name="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.
25+
26+
---
27+
## Matches
28+
1. Close match of [whatever](url)
29+
30+
## References
31+
<a name="fn1">\[1\]</a> Source: ...

0 commit comments

Comments
 (0)