Commit 8a302b0e authored by Richard Olav Rud's avatar Richard Olav Rud
Browse files

Update

parent 29bea5fc
......@@ -52,8 +52,7 @@ Table of Contents
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.
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.
this tool is for starting data that is not regularly produced within the RIs, but to service research projects and TNA that now are lost and not available for anyone in the future.
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.
### 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).
......@@ -102,12 +101,13 @@ Browser based application, should work on all operating systems and accross the
* Edge
### 2.5 Design and Implementation Constraints
E.g. The "Homeless data portal" application will be develop in python on an nginx server where build and deploy is handled by gitlab and jenkins.
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.
### 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 spcific dependencies to run.
## External Interface Requirements
......@@ -115,9 +115,14 @@ User documentation will be created when the prototype of the portal is operation
Details of the user interface design will be documented in a separate user interface specification (MS 5.2).
### 3.3 Software Interfaces
Describe the connections between the "Homeless data portal" and the other specific software components that are related to RI specific tools. This includes everything we believe should be a integrated part of the "Homless data portal2 e.g. databases, operating systems, tools, libraries, and integrated commercial components.
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
Identify the data items or messages coming into the system and going out and describe the purpose of each. Describe the services needed and the nature of communications. Refer to documents that describe detailed application programming interface protocols. Identify data that will be shared across software components. If the data sharing mechanism must be implemented in a specific way, specify this as an implementation constraint.
**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?**
......@@ -199,9 +204,12 @@ Figure x: Components and software interfaces
* Embargo
* Licencing etc.
11. Way to declare a collection of datasets.
11. Is this a collection of datasets.
* Yes
* No
12. Ask the expected volume of the data
12. Expected volume of the data
* Provide file or size of collection collection in mb
### 4.2 Workflows
......
img/figure4.png

75 KB | W: | H:

img/figure4.png

76.9 KB | W: | H:

img/figure4.png
img/figure4.png
img/figure4.png
img/figure4.png
  • 2-up
  • Swipe
  • Onion skin
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment