README.md 12.2 KB
Newer Older
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
1
# ATMO-ACCESS Task5.1-SRS
Richard Olav Rud's avatar
Richard Olav Rud committed
2

3
4
5
IEEE System Requirements Specification Template

# Software Requirements Specification
Richard Olav Rud's avatar
Richard Olav Rud committed
6
## For Task 5.1 Development of online tools for data curation of homeless data
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Table of Contents
=================
  * [Introduction](#1-introduction)
    * 1.1 [Purpose](#11-purpose)
    * 1.2 [Document Conventions](#12-document-conventions)
    * 1.3 [Intended Audience and Reading Suggestions](#13-intended-audience-and-reading-suggestions)
    * 1.4 [Product Scope](#14-product-scope)
    * 1.5 [References](#15-references)
  * [Overall Description](#overall-description)
    * 2.1 [Product Perspective](#21-product-perspective)
    * 2.2 [Product Functions](#22-product-functions)
    * 2.3 [User Classes and Characteristics](#23-user-classes-and-characteristics)
    * 2.4 [Operating Environment](#24-operating-environment)
    * 2.5 [Design and Implementation Constraints](#25-design-and-implementation-constraints)
    * 2.6 [User Documentation](#26-user-documentation)
    * 2.7 [Assumptions and Dependencies](#27-assumptions-and-dependencies)
  * [External Interface Requirements](#external-interface-requirements)
    * 3.1 [User Interfaces](#31-user-interfaces)
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
26
    * 3.2 [Software Interfaces](#32-software-interfaces)
27
  * [System Features](#system-features)
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
28
29
    * 4.1 [Interactive form](#41-interactive-form)
    * 4.2 [Workflows](#42-workflows)
30
31
32
33
  * [Other Requirements](#other-requirements)
* [Appendix A: Glossary](#appendix-a-glossary)

## 1. Introduction
Richard Olav Rud's avatar
Richard Olav Rud committed
34
35
36

### 1.1 Purpose
The purpose of this document is to present a detailed description of the homeless data portal and the underlying RI specific tools for data curation, QC and archiving of data. Furthermore, the document will present the features and interface of the application, what the application will do, as well as constraints related to RI specific tools and workflows. The document is intended for stakeholders in the projects, developers and users of the application.
37
38

### 1.2 Document Conventions
Richard Olav Rud's avatar
Richard Olav Rud committed
39
40
This Document was created based on the [IEEE template for System Requirement Specification Documents](https://doi.org/10.1109/IEEESTD.1996.81000).

41
### 1.3 Intended Audience and Reading Suggestions
Richard Olav Rud's avatar
Richard Olav Rud committed
42
43

* Programmers who will work on developing the software.
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
44
* Stakeholder who will need to validate the requirements, making sure they fulfill what is in the project description.
Richard Olav Rud's avatar
Richard Olav Rud committed
45
46
* Researchers who have or will perform TNA activities or campaign measurements.

47
### 1.4 Product Scope
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
48

Richard Olav Rud's avatar
Richard Olav Rud committed
49
50
51
52
53
The Homeless data portal is set up to serve scientists producing atmospheric measurements and time series resulting from research campaigns and TNA activities that are normally not included into any data management and data curation system and activity. These data sets are “homeless data”, not associated with any long-term projects nor sustainable data centres. The objective of this task is to develop tools facilitating access to TNA data and campaign data for future use through long term, sustainable data centres. The goal of the tool is to make more data available to the end-user, as well as benefits for data collectors in terms of usage tracking and access to RI specific tools for curation and data access.

The Homeless data portal is not a QA tool, but and archiving and access tool to data that is currently not curated anywhere today. The goal is to document the homeless data through rich meta data to document quality, and provide access.
This tool is for data that is not regularly produced within the RIs, but as an offer to research projects and TNA activities, making sure that also this data is available for future use.

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
54
More information on the ATMO-ACCESS project could be found [here](https://www.atmo-access.eu/project/work-packages/).
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
55

56
### 1.5 References
Richard Olav Rud's avatar
Richard Olav Rud committed
57
* [ATMO-ACCESS project website](https://www.atmo-access.eu/)
58
59
60

## Overall Description
### 2.1 Product Perspective
61
The homeless data portal will be developed for everyone collecting atmospheric composition data during TNA and campaign activities.
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
62
The goal is to directly curate and store TNA and campaign datasets in long-term repositories.
63

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
64
The homeless data portal will be a simple form based one-page application. The form will prompt multiple questions that the data provider will need to answer in order to describe their data. Based on the description and metadata selected in the form, the application will automatically route the request to the relevant RI. If it is not clear from the answers in the form which RI the data belongs to, a combined effort will be made.
65
All requests will end up in a issue tracking system, where tasks are delegated to data curators at the specific RIs.
Richard Olav Rud's avatar
Richard Olav Rud committed
66

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
67
In addition, it should be possible for the different RIs, to connect their specific data curation workflows to the API of the issue tracking systems, in cases where it is possible to automate parts of the data curation process. A more detailed explanation of RI specific workflows are available [here](#42-workflows)
68

69
![Rough sketch of the components in the system](img/atmo-access-homeless-data-portal.png)
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
70
Figure 1: Homeless data portal overview
Richard Olav Rud's avatar
Richard Olav Rud committed
71

72
### 2.2 Product Functions
Richard Olav Rud's avatar
Richard Olav Rud committed
73

Richard Olav Rud's avatar
Richard Olav Rud committed
74
75
76
#### User View

* Form:
77
  * Open the website, fill in form with PI information and information describing the dataset or collection of dataset from TNA and/or campaign activities.
Richard Olav Rud's avatar
Richard Olav Rud committed
78
* Feedback:
79
  * User will receive an email confirmation and a link to the issue tracking system.
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
80
* Issue tracking system:
81
  * Open issue tracking system, see "tickets" associated to a specific user, as well as the status.
Richard Olav Rud's avatar
Richard Olav Rud committed
82
83
84
85

#### System View

* Form:
86
  * Form information is stored and metadata from form selection is provided to the API of the issue tracking system.
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
87
88
89
* Workflows:
  * Depending on the selected parameters and other relevant metadata from the "Homeless data portal" form, different workflows will be triggered in the issue tracking system.
  * Form will trigger storage of data in those cases where the data provider wants to provide examples or send the whole dataset together with the form metadata.
90
  * If a file is provide, the file will be saved to a secondary archive, to ensure backup and traceability.
Richard Olav Rud's avatar
Richard Olav Rud committed
91
* Feedback
92
  * Issue tracking system will be "in-charge" of sending feedback upon creation and update of a specific issue.
93
  * Feedback to the data provider from any step in the data curation workflow at each RI, should be provided through the centralized issue tracking system.
Richard Olav Rud's avatar
Richard Olav Rud committed
94
95

#### Research Infrastructure (RI) View
96
97
* RI will look through the request for providing data and accept/decline in the issue tracking system.
* RI will provide all feedback through the issue tracking system.
98
* It should be possible for RI to utilize issue tracking API for integrating the data curation process with their internal workflow and data curation tools.
Richard Olav Rud's avatar
Richard Olav Rud committed
99
100
101

### 2.3 User Classes and Characteristics

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
102
103
Multiple type of users, not only users internal to the RIs. Can be users from both free external research projects, in addition to ATMO-ACCESS TNA.
For example:
Richard Olav Rud's avatar
Richard Olav Rud committed
104
105
106
107
108
* Researchers, data providers and technical staff that are part of campaigns and TNA activities.
* Data curators at each RI
* Developers who is working on the project and further developing the functionality

### 2.4 Operating Environment
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
109
Browser based application, should work on all operating systems and across the most commonly used web-browsers.
Richard Olav Rud's avatar
Richard Olav Rud committed
110
111

### 2.5 Design and Implementation Constraints
112
The first version of the requirements specification will not include any specific information on design and implementation. This will be handled in MS5.2 (Mockups of services presented to user panels) and MS5.3 (Prototype services presented to user panels​).
Richard Olav Rud's avatar
Richard Olav Rud committed
113
114

### 2.6 User Documentation
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
115
User documentation will be created when the prototype of the portal is operational (estimated 1th of October 2022).
Richard Olav Rud's avatar
Richard Olav Rud committed
116
117

### 2.7 Assumptions and Dependencies
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
118
The application will run in the browser, and therefore it will not require any specific dependencies to run.
Richard Olav Rud's avatar
Richard Olav Rud committed
119
120
121
122
123
124

## External Interface Requirements

### 3.1 User Interfaces
Details of the user interface design will be documented in a separate user interface specification (MS 5.2).

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
125
### 3.2 Software Interfaces
126
127
The "Homeless data portal" will need to connect to the issue tracking system through an API.
The "Homeless data portal" will need to connect to a secondary storage system through an API.
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
128

Richard Olav Rud's avatar
Richard Olav Rud committed
129
130
131
## System Features

### 4.1 Interactive form
Richard Olav Rud's avatar
Richard Olav Rud committed
132

Richard Olav Rud's avatar
Richard Olav Rud committed
133
#### Form elements
Richard Olav Rud's avatar
Richard Olav Rud committed
134

135
136
137
* All elements should be multiple choice, so it would be possible to specify metadata for a collection of datasets

1. Atmospheric component(s) you are working with
Richard Olav Rud's avatar
Richard Olav Rud committed
138
139
140
141
142
143
  * Aerosol
  * Greenhouse gases
  * Reactive trace gases
  * Clouds
  * Other

144
145
146
147
148
149
150
151
2. Observation type
  * Ground based In-Situ observations
  * Ground based Remote sensing observations
  * Aircraft measurements (remote or in-situ)
  * Other mobile/moving platforms (remote or in-situ)
  * Other, please specify

3. What specific kind of measurement data do you want to submit and archive for long term access?
Richard Olav Rud's avatar
Richard Olav Rud committed
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
  * Gas concentrations/mixing ratio: Greenhouse gases (CO2, CH4, N2O)
  * Gas concentrations/mixing ratio: Greenhouse gases (halocarbons and other fluorinated gases)
  * Gas concentrations/mixing ratio: Reactive trace gases (VOC, NOxy, ozone, CO)
  * Aerosol properties: Ground based In-Situ aerosol optical, physical and chemical properties
  * Aerosol properties: Remote observations from ground – profiles
  * Aerosol properties: Remote observations from ground – total column
  * Cloud properties: Ground based In-Situ measurements
  * Cloud properties : Ground based remote sensing observations – profiles

4. Location of measurements site(s)?
  * One country in Europe
  * Europe
  * Northern Hemisphere
  * Southern Hemisphere
  * Arctic regions
  * Antarctic region
  * Globally distributed
  * Asia
  * America

172
5. What is the nature of the data you would like to store?
Richard Olav Rud's avatar
Richard Olav Rud committed
173
174
175
176
  * Campaign data
  * Annual data
  * Other, please specify

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
177
178
179
6. Is your data currently formatted and undergoing certain quality assurance criteria, or unformatted/not quality assured?
  * Includes metadata and quality controlled data for defined criteria (processed data)
  * Only partly include metadata or quality controlled data for defined criteria
Richard Olav Rud's avatar
Richard Olav Rud committed
180
181
182
  * Not formatted nor quality assured

7. Contact information
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
183
184
185
186
187
188
189
190
191
192
193
194
195
196
  * First name
  * Last name
  * Organization name
  * Country code
  * Delivery point
  * Address city
  * Administrative area
  * Postal code
  * Email
  * Position name

8. Attach an file or example of your data (optional)

9. Specific constraints
Richard Olav Rud's avatar
Richard Olav Rud committed
197
198
199
  * Embargo
  * Licencing etc.

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
200
10. Is this a collection of datasets.
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
201
202
  * Yes
  * No
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
203

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
204
11. Expected volume of the data
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
205
  * Provide file or size of collection collection in mb
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
206

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
207
12. Other relevant information?
Richard Olav Rud's avatar
Richard Olav Rud committed
208

Richard Olav Rud's avatar
Richard Olav Rud committed
209
### 4.2 Workflows
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
210

Richard Olav Rud's avatar
Richard Olav Rud committed
211
#### ACTRIS
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
212

Richard Olav Rud's avatar
Richard Olav Rud committed
213
##### ACTRIS InSitu
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
214

215
Within ACTRIS, the data submission & curation process is tracked in an issue tracker to have traceable quality control. The issue status indicates where the submission is located in the process. The issue status also indicates who is responsible for the next step.
216
Below the workflow description and figure describing the ACTRIS In Situ workflow is included.
217

218
![ACTRIS InSitu workflow description](img/in-situ-workflow-description.png)
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
219
Table 1: ACTRIS InSitu workflow description
220

221
![Workflow ACTRIS InSitu](img/actris-insitu-workflow.png)
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
222
Figure 2: ACTRIS InSitu workflow
Richard Olav Rud's avatar
Richard Olav Rud committed
223

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
224
##### ACTRIS GRES
Richard Olav Rud's avatar
Richard Olav Rud committed
225

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
226
227
![Workflow ACTRIS GRES](img/actris-gres.atmo-access.workflow.png)
Figure 3: ACTRIS GRES workflow
Richard Olav Rud's avatar
Richard Olav Rud committed
228

Richard Olav Rud's avatar
Richard Olav Rud committed
229
#### IAGOS
Richard Olav Rud's avatar
Richard Olav Rud committed
230

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
231
232
233
![Workflow IAGOS](img/iagos.atmo-access.workflow.png)
Figure 4: IAGOS workflow

Richard Olav Rud's avatar
Richard Olav Rud committed
234
235
236
237
238
#### ICOS

![Workflow ICOS](img/icos.atmo-access.workflow.png)
Figure 4: ICOS workflow

239
## Other Requirements
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
240
* Storage of data and metadata must follow GDPR requirements.
241
* This system aims to use a common login solution for authentication and authorization in WP5. The authentication and authorization should be done at a higher level, and the specific implementation is not to be considered as a part of this task.
242
243

### Appendix A: Glossary
Richard Olav Rud's avatar
Richard Olav Rud committed
244
245
246
247
248
* **Homeless Data:** Data resulting from research campaigns and TNA activities are normally not included into any data management and data curation system and activity. These data sets are “homeless data”, not associated with any long-term projects nor sustainable data centres. The objective of this task is to develop tools facilitating access to TNA data and campaign data for future use through long term, sustainable data centres”

### Appendix B: User Survey Task 5.1

![User Survey Task 5.1](docs/user_survey_task5.1.pdf)