README.md 11.8 KB
Newer Older
Richard Olav Rud's avatar
Richard Olav Rud committed
1
2
# task5.1-SRS

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
26
27
28
29

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)
    * 3.2 [Hardware Interfaces](#32-hardware-interfaces)
    * 3.3 [Software Interfaces](#33-software-interfaces)
    * 3.4 [Communications Interfaces](#34-communications-interfaces)
  * [System Features](#system-features)
Richard Olav Rud's avatar
Richard Olav Rud committed
30
31
    * 4.1 [Interactive form](#41-interactive-form-1)
    * 4.2 [4.2 Workflows](#42-workflows)
32
  * [Other Nonfunctional Requirements](#other-nonfunctional-requirements)
Richard Olav Rud's avatar
Richard Olav Rud committed
33
    * 5.1 [5.1 Safety and Security Requirements](#51-safety-and-security-requirements)
34
35
36
37
  * [Other Requirements](#other-requirements)
* [Appendix A: Glossary](#appendix-a-glossary)

## 1. Introduction
Richard Olav Rud's avatar
Richard Olav Rud committed
38
39
40

### 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.
41

42
This is not a QA tool, but and archiving and access tool to data that is currently not curated anywhere today. The crucial point is to document the homeless data through rich meta data to document quality, and provide access.
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
43
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.
44

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

48
### 1.3 Intended Audience and Reading Suggestions
Richard Olav Rud's avatar
Richard Olav Rud committed
49
50
51
52
53

* Programmers who will work on developing the software.
* Stakeholder who will need to validate the requirements, making sure they fullfill what is in the project description.
* Researchers who have or will perform TNA activities or campaign measurements.

54
### 1.4 Product Scope
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
55
56

The homeless data portal is a tool to help those who collect data from TNA activities and campaigns with long-term storage of data at relevant research infrastructure. 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 as well as data access.
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
57
In addition, data produced by the "Interactive time series analysis tool" (Task 5.3) would promote the use of the homeless data portal for data curation on user demand.
58
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
59

60
### 1.5 References
Richard Olav Rud's avatar
Richard Olav Rud committed
61
* [ATMO-ACCESS project website](https://www.atmo-access.eu/)
62
63
64

## Overall Description
### 2.1 Product Perspective
65
66
67
The homeless data portal will be developed for everyone collecting atmospheric composition data during TNA and campaign activities.
The goal is to directly curate and store TNA and campain datasets in long-term repositories.

68
The homeless data portal will be 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.
69
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
70

71
72
73
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 aumotate parts of the data curation process. A more detailed explanation of RI specific workflows are available [here](#42-workflows)

![Rought sketch of the components in the system](img/atmo-access-description.png)
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
74
Figure 1: Homeless data portal overview
Richard Olav Rud's avatar
Richard Olav Rud committed
75

76
### 2.2 Product Functions
Richard Olav Rud's avatar
Richard Olav Rud committed
77

Richard Olav Rud's avatar
Richard Olav Rud committed
78
79
80
81
82
83
#### User View

* Form:
  * Open the website, fill in form with PI information and information describing the dataset or collection of dataset from TNA and/or campaign activities
* Feedback:
  * User will recieve email confirmation and a link to the issue tracking system
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
84
* Issue tracking system:
85
  * 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
86
87
88
89
90

#### System View

* Form:
  * Form information is stored and metadata from form selction is provided to the API of the issue tracking system
91
92
93
  * 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 thes metadata.
  * If file is provide, the file will be saved to a secondary archive, to ensure backup and tracebility
Richard Olav Rud's avatar
Richard Olav Rud committed
94
* Feedback
95
  * Issue tracking system will be "in-charge" of sending feedback upon creation and update of a specific issue.
Richard Olav Rud's avatar
Richard Olav Rud committed
96
97
98
99

#### Research Infrastructure (RI) View
* 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
100
* 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
101
102
103

### 2.3 User Classes and Characteristics

104
It will be all 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.
Richard Olav Rud's avatar
Richard Olav Rud committed
105
106
107
108
109
* 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
110
Browser based application, should work on all operating systems and accross the most commonly used web-browsers.
Richard Olav Rud's avatar
Richard Olav Rud committed
111
112

### 2.5 Design and Implementation Constraints
113
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
114
115

### 2.6 User Documentation
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
116
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
117
118

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

## 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).

### 3.3 Software Interfaces
127
128
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
129

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

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

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

136
137
138
* 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
139
140
141
142
143
144
  * Aerosol
  * Greenhouse gases
  * Reactive trace gases
  * Clouds
  * Other

145
146
147
148
149
150
151
152
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
  * 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

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

178
6. Is your data currently formatted and undergoing certain quality assurance criterias, or unformatted/not quality assured?
Richard Olav Rud's avatar
Richard Olav Rud committed
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
  * Includes metadata and quality controlled data for defined critereas (processed data)
  * Only partly include metadata or quality controlled data for defined critereas
  * Not formatted nor quality assured

7. Contact information
  * first_name
  * last_name
  * organisation_name
  * country_code
  * delivery_point
  * address_city
  * administrative_area
  * postal_code
  * email
  * position_name

8. Other relevant information?

9. Attach an file or example of your data

10. Speific constraints
  * Embargo
  * Licencing etc.

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
203
204
205
11. Is this a collection of datasets.
  * Yes
  * No
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
206

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
207
208
12. Expected volume of the data
  * Provide file or size of collection collection in mb
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
209

Richard Olav Rud's avatar
Richard Olav Rud committed
210

Richard Olav Rud's avatar
Richard Olav Rud committed
211
### 4.2 Workflows
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
212

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

Richard Olav Rud's avatar
Richard Olav Rud committed
215
##### ACTRIS InSitu
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
216

217
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.
218
Below the workflow description and figure describing the ACTRIS In Situ workflow is included.
219

220
![ACTRIS InSitu workflow description](img/in-situ-workflow-description.png)
221
222
Table x: ACTRIS InSitu workflow description

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

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
226
##### ACTRIS GRES
Richard Olav Rud's avatar
Richard Olav Rud committed
227

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

Richard Olav Rud's avatar
Richard Olav Rud committed
231
#### IAGOS
Richard Olav Rud's avatar
Richard Olav Rud committed
232

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

Richard Olav Rud's avatar
Richard Olav Rud committed
236
#### ICOS
Richard Olav Rud's avatar
Richard Olav Rud committed
237

238
## Other Requirements
Richard Olav Rud's avatar
Richard Olav Rud committed
239
240
### 5.1 Safety and Security Requirements
Storage of data and metadata must follow GDPR requirements.
241
242

### Appendix A: Glossary
243
244
* **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”