User stories
Instruction
Requirements are based on a user story, which is is an informal, natural language description of one or more features of a software system. User stories are often written from the perspective of an end user or user of a system. Depending on the community, user stories may be written by various stakeholders including clients, users, managers or development team members. They facilitate sensemaking and communication, that is, they help software teams organize their understanding of the system and its context. Please do not confuse user story with system requirements. A user story is an informal description of a feature; a requirement is a formal description of need (See section later).
User stories may follow one of several formats or templates. The most common would be:
"As a <role>, I want <capability> so that <receive benefit>"
"In order to <receive benefit> as a <role>, I want <goal/desire>"
"As <persona>, I want <what?> so that <why?>" where a persona is a fictional stakeholder (e.g. user). A persona may include a name, picture; characteristics, behaviours, attitudes, and a goal which the product should help them achieve.
Example:
“As provider of the Climate gateway I want to empower researchers from academia to interact with datasets stored in the Climate Catalogue, and bring their own applications to analyse this data on remote cloud servers offered via EGI.”
EISCAT_3D will generate raw data at a few observation sites (antennas) and has to make those data browsable and analysable for researchers, as well as archiving the data for the long-term. This primary mission is achieved by procuring sufficiently big storage and network capacities at a few data/compute centres (for back-up or load distribution). The raw data is transferred to this/these locations, often after initial filtering and calibration at the data source(s). The data/compute centres are responsible for data archival, data curation, generation of derived data (level 1-2-3) and for sharing the data with scientists.
Data must be shared with scientists via a data portal and programming APIs. The 'EISCAT_3D Data Portal' should offer the following main features:
- User login
- Data browser
- Data download
- Online computing (analyse data without downloading them, using remote cloud resources and reference applications)
The CC is exploring the use of the following EOSC-hub services:
Application and data catalogue portal with compute integration: DIRAC
Metadata catalogue for high-level data: B2Find
Metadata catalogue for low-level data: Dirac
Compute resources: EISCAT, EGI HTC, EGI Cloud, institutional clouds (e.g. at CSC)
Data storage and transfer (data→compute centres): B2STAGE
User SSO: EGI CheckIn and B2Access
No. | User stories |
|---|---|
US1 | Any researcher should be able to access the portal and browse metadata. The portal grants/denies access to data and processing based on affiliation. |
US2 | Authorised researchers should be able to select the EISCAT_3D data they are interested in for download or for analysis. |
US3 | Authorised researchers should be able to browse reference applications in the portal, select an application for use, feed their data in (from US2), visualise or download the analysis result. |
Use cases
Instruction
A use case is a list of actions or event steps typically defining the interactions between a role (known in the Unified Modeling Language as an actor) and a system to achieve a goal.
Include in this section any diagrams that could facilitate the understanding of the use cases and their relationships.
Step | Description of action | Dependency on 3rd party services (EOSC-hub or other) |
|---|---|---|
UC1 | Authentication:
|
|
UC2 | Data access:
|
|
UC3 | Computation:
|
|
Requirements
Technical Requirements
Requirement ID | EOSC-hub service | GAP (Yes/No) + description | Requirement description | Source Use Case |
|---|---|---|---|---|
RQ1 | EOSC-hub AAI | Yes: Dirac | Dirac interface to EGICheckin | UC1 |
| RQ2 | VM | Yes: VM | VM for portal | UC1 |
| RQ3 | Data staging | Yes: File system | File storage | UC3 |
RQ4 | Cloud Compute | Yes: HPC | Run software | UC3 |
| RQ5 | PID/DOI service | Yes: Registry | Registration of collection | UC2,3 |
Capacity Requirements
EOSC-hub services | Amount of requested resources | Time period |
|---|---|---|
| Portal | 2 VMs | 30 yrs |
| Stage | 2 VMs 10 TB | 5 yrs |
| Processing | 2 VMs 10 cores | 5 yrs |
