README.md

# ATMO-ACCESS Task5.1-SRS

IEEE System Requirements Specification Template

# Software Requirements Specification
## For Task 5.1 Development of online tools for data curation of homeless data

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 [Software Interfaces](#32-software-interfaces)
  * [System Features](#system-features)
    * 4.1 [Interactive form](#41-interactive-form)
    * 4.2 [Workflows](#42-workflows)
  * [Other Requirements](#other-requirements)
* [Appendix A: Glossary](#appendix-a-glossary)

## 1. Introduction

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

### 1.2 Document Conventions
This Document was created based on the [IEEE template for System Requirement Specification Documents](https://doi.org/10.1109/IEEESTD.1996.81000).

### 1.3 Intended Audience and Reading Suggestions

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

### 1.4 Product Scope

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.

More information on the ATMO-ACCESS project could be found [here](https://www.atmo-access.eu/project/work-packages/).

### 1.5 References
* [ATMO-ACCESS project website](https://www.atmo-access.eu/)

## Overall Description
### 2.1 Product Perspective
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 campaign datasets in long-term repositories.

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.
All requests will end up in a issue tracking system, where tasks are delegated to data curators at the specific RIs.

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)

![Rough sketch of the components in the system](img/atmo-access-homeless-data-portal.png)
![Flow diagram](img/flow-diagram-atmo-access.png)
Figure 1: Homeless data portal overview

### 2.2 Product Functions

#### 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 receive an email confirmation and a link to the issue tracking system.
* Issue tracking system:
  * Open issue tracking system, see "tickets" associated to a specific user, as well as the status.

#### System View

* Form:
  * Form information is stored and metadata from form selection is provided to the API of the issue tracking system.
* 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.
  * If a file is provide, the file will be saved to a secondary archive, to ensure backup and traceability.
* Feedback
  * Issue tracking system will be "in-charge" of sending feedback upon creation and update of a specific issue.
  * 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.

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

### 2.3 User Classes and Characteristics

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:
* 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 across the most commonly used web-browsers.

### 2.5 Design and Implementation Constraints
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​).

### 2.6 User Documentation
User documentation will be created when the prototype of the portal is operational (estimated 1th of October 2022).

### 2.7 Assumptions and Dependencies
The application will run in the browser, and therefore it will not require any specific dependencies to run.

## External Interface Requirements

### 3.1 User Interfaces

![Overview](img/mockups/overview.png)
Figure x: Mockups overview in Figma

![Login](img/mockups/login_view.png)
Figure x: Login

![Form](img/mockups/form.png)
Figure x: Form

![Feedback on submit](img/mockups/feedbackOnSubmit.png)
Figure x: Feedback on submit

![Mantis](img/mockups/mantis.png)
Figure x: Issue tracking system

### 3.2 Software Interfaces
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.

## System Features

### 4.1 Interactive form

#### Form elements

* 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
  * Aerosol
  * Greenhouse gases
  * Reactive trace gases
  * Clouds
  * Other

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

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

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
  * Not formatted nor quality assured

7. Contact information
  * 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
  * Embargo
  * Licencing etc.

10. Is this a collection of datasets.
  * Yes
  * No

11. Expected volume of the data
  * Provide file or size of collection collection in mb

12. Other relevant information?

### 4.2 Workflows

#### ACTRIS

##### ACTRIS InSitu

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

![ACTRIS InSitu workflow description](img/in-situ-workflow-description.png)
Table 1: ACTRIS InSitu workflow description

![Workflow ACTRIS InSitu](img/actris-insitu-workflow.png)
Figure 2: ACTRIS InSitu workflow

##### ACTRIS GRES

![Workflow ACTRIS GRES](img/actris-gres.atmo-access.workflow.png)
Figure 3: ACTRIS GRES workflow

#### IAGOS

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

#### ICOS

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

## Other Requirements
* Storage of data and metadata must follow GDPR requirements.
* 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.

### Appendix A: Glossary
* **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)

### Appendix C:

![Roadmap](img/Roadmap.jpg)