README.md 11.6 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
7
8
9
10
## For Task 5.1 Development of online tools for data curation of homeless data
Version 0.1 approved
Prepared by Richard Rud
NILU - Norwegian Institute for Air Research
2021-09-14
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

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
34
35
    * 4.1 [Interactive form](#41-interactive-form-1)
    * 4.2 [4.2 Workflows](#42-workflows)
36
  * [Other Nonfunctional Requirements](#other-nonfunctional-requirements)
Richard Olav Rud's avatar
Richard Olav Rud committed
37
    * 5.1 [5.1 Safety and Security Requirements](#51-safety-and-security-requirements)
38
39
40
41
  * [Other Requirements](#other-requirements)
* [Appendix A: Glossary](#appendix-a-glossary)

## 1. Introduction
Richard Olav Rud's avatar
Richard Olav Rud committed
42
43
44

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

46
This is not a QA tool, but and archiving and access tool to data that is now not curated anywhere. 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
47
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.
48

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

52
### 1.3 Intended Audience and Reading Suggestions
Richard Olav Rud's avatar
Richard Olav Rud committed
53
54
55
56
57

* 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.

58
### 1.4 Product Scope
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
59
60
61
62
63

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.
(*Refer here also to the project description.)


64
### 1.5 References
Richard Olav Rud's avatar
Richard Olav Rud committed
65
* [ATMO-ACCESS project website](https://www.atmo-access.eu/)
66
67
68

## Overall Description
### 2.1 Product Perspective
Richard Olav Rud's avatar
Richard Olav Rud committed
69
70
The homeless data portal will be developed for everyone collecting atmospheric composition data during TNA and campaign activities. The homeless data portal will be a form based application that will route requests for data curation and storage to specific RIs based on the provided metadata in the forms. The goal is then to directly curate and store TNA and campain datasets or if a dataset is not directly supported by the relevant RI, establish bi-lateral contact with the data curation team at a given RI.

Richard Olav Rud's avatar
Richard Olav Rud committed
71
![Rought sketch of the components in the system](img/figure1.png)
Richard Olav Rud's avatar
Richard Olav Rud committed
72
73
Figure 1: Rough sketch

74
### 2.2 Product Functions
Richard Olav Rud's avatar
Richard Olav Rud committed
75

Richard Olav Rud's avatar
Richard Olav Rud committed
76
77
78
79
80
81
#### 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
82
* Issue tracking system:
Richard Olav Rud's avatar
Richard Olav Rud committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
  * Open issue tracking system, see "tickets" associated to a users request for providing data

#### System View

* Form:
  * Form information is stored and metadata from form selction is provided to the API of the issue tracking system
  * Workflows: Depending on the selected paramters 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 metadata.
  * If file is provide, save file to archive. Metadata will be stored and triggers a given workflow, should include feedback and email functionality.
  * Storage: Possibility to store submitted metadata and files via forms to a archive for backup and tracebility.
* Feedback
  * Issuetracking system will be "in-charge" of sending feedback upon creation and update of a specific issue.
* Issue tracking system
  * Functionality of issue tracking system should be treated like a black-box

#### 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
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
110
111
112
113
* 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
Browser based application, should work on all operating systems and accross the most commonly used web-browsers. As a minimum requirement, the application should be tested in the following web-browsers:
* Chrome
* Safari
* Firefox
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
114
* Edge
Richard Olav Rud's avatar
Richard Olav Rud committed
115
116

### 2.5 Design and Implementation Constraints
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
117
E.g. The "Homeless data portal" application will be develop using vue.js on an nginx server where build and deploy is handled by gitlab and jenkins.
Richard Olav Rud's avatar
Richard Olav Rud committed
118
119

### 2.6 User Documentation
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
120
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
121
122

### 2.7 Assumptions and Dependencies
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
123
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
124
125
126
127
128
129
130

## 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
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
131
132
133
134
135
136
137
The "Homeless data portal" will only connect to the Mantis issue tracking system through the Mantis API and a file storage system, preferably cloud based like one drive or nextcloud.

Mantis Bug Tracker REST API: https://documenter.getpostman.com/view/29959/mantis-bug-tracker-rest-api/7Lt6zkP

**To be considered:**
OneDrive API for python: https://github.com/OneDrive/onedrive-sdk-python
Python wrapper for NextCloud API: https://github.com/matejak/nextcloud-API
Richard Olav Rud's avatar
Richard Olav Rud committed
138
139


Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
140
141
142
143
144
145
**Will need to describe connection the connection through the Mantis API and workflow tools at the RI level, if this should be a part of the scope?**

![Rought sketch of the components in the system](img/figure4.png)
Figure x: Components and software interfaces


Richard Olav Rud's avatar
Richard Olav Rud committed
146
147
148
## System Features

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

Richard Olav Rud's avatar
Richard Olav Rud committed
150
#### Form elements
Richard Olav Rud's avatar
Richard Olav Rud committed
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

1. Atmospheric component(s) you are working with Immersive Reader
  * Aerosol
  * Greenhouse gases
  * Reactive trace gases
  * Clouds
  * Other

2. What specific kind of measurement data do you want to submit and archive for long term access? Immersive Reader
  * 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
  * Ballon?
  * Model?
  * Metrology

3. Observation type
  * Ground based In-Situ observations
  * Ground based Remote sensing observations
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
175
176
  * Aircraft measurements (remote or in-situ)
  * Other mobile/moving platforms (remote or in-situ)
Richard Olav Rud's avatar
Richard Olav Rud committed
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
  * Other, please specify

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

5. What is the nature of the data you would like to store? Immersive Reader
  * Campaign data
  * Annual data
  * Other, please specify

6. Is your data currently formatted and undergoing certain quality assurance criterias, or unformatted/not quality assured?  Immersive Reader
  * 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
220
221
222
11. Is this a collection of datasets.
  * Yes
  * No
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
223

Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
224
225
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
226

Richard Olav Rud's avatar
Richard Olav Rud committed
227

Richard Olav Rud's avatar
Richard Olav Rud committed
228
### 4.2 Workflows
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
229

Richard Olav Rud's avatar
Richard Olav Rud committed
230
#### ACTRIS
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
231

Richard Olav Rud's avatar
Richard Olav Rud committed
232
##### ACTRIS InSitu
Richard Olav Rud's avatar
Update    
Richard Olav Rud committed
233
234
New task: Data and metadata will be stored and email containing link to data curation tools will be sent to the data provider. A task will be created in the InSitu issue tracker system.

Richard Olav Rud's avatar
Richard Olav Rud committed
235
236
Figure ![Workflow ACTRIS InSitu](img/figure2.png)
Figure 2: ACTRIS InSitu workflow
Richard Olav Rud's avatar
Richard Olav Rud committed
237

Richard Olav Rud's avatar
Richard Olav Rud committed
238
##### ACTRIS CLU
Richard Olav Rud's avatar
Richard Olav Rud committed
239

Richard Olav Rud's avatar
Richard Olav Rud committed
240
##### ACTRIS ARES
Richard Olav Rud's avatar
Richard Olav Rud committed
241

Richard Olav Rud's avatar
Richard Olav Rud committed
242
#### IAGOS
Richard Olav Rud's avatar
Richard Olav Rud committed
243

Richard Olav Rud's avatar
Richard Olav Rud committed
244
#### ICOS
Richard Olav Rud's avatar
Richard Olav Rud committed
245

Richard Olav Rud's avatar
Richard Olav Rud committed
246
#### Other
247

248
249
250
Figure ![Workflow ACTRIS InSitu](img/figure3.png)
Figure 3: Workflow for the Homless data portal

251
## Other Nonfunctional Requirements
Richard Olav Rud's avatar
Richard Olav Rud committed
252
253
### 5.1 Safety and Security Requirements
Storage of data and metadata must follow GDPR requirements.
254
255
256

## Other Requirements
Define any other requirements not covered elsewhere in the SRS. This might include database requirements, internationalization requirements, legal requirements, reuse objectives for the project, and so on. Add any new sections that are pertinent to the project.
Richard Olav Rud's avatar
Richard Olav Rud committed
257

258
### Appendix A: Glossary
259
260
* **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”