Loading...

Change Owns to Parent Ofs

Set start and due date...

Xporter

XML

Word

Printable

Details

Type: Feature
Priority: Not Assigned
Fix Version/s: PI8
Component/s: COM SDP SW, COM Support & Simulation Tools
Labels:
None

ARTs:

Data Processing
Benefit hypothesis:

Hide

Simulations have already played an important role in developing the SKA, and this is expected to continue into construction and commissioning with contribution from users and developers outside of the current DP agile teams.

An single online location that provides discovery and documentation will allow new advanced SKA users and developers of simulations (eg. system scientists, AIV engineers, and SDP workflow developers) to be able to more easily run, modify and contribute to simulations in future, reducing the risk of duplication of work.

Show
Simulations have already played an important role in developing the SKA, and this is expected to continue into construction and commissioning with contribution from users and developers outside of the current DP agile teams. An single online location that provides discovery and documentation will allow new advanced SKA users and developers of simulations (eg. system scientists, AIV engineers, and SDP workflow developers) to be able to more easily run, modify and contribute to simulations in future, reducing the risk of duplication of work.
Acceptance criteria:
Hide

Read-the-docs website (or equivalent) with suitable hierarchical structure that can be used to describe current and future SKA1 simulations. Simulations described by this should include:

A short description of what the simulation does / is used for.

A description of inputs, configuration, and any outputs that have already been generated

The dependencies and requirements (including compute hardware) for running each simulation

Description of how to contribute new simulations to this website and where scripts and simulation data (inputs and results) are be stored / hosted either as part of this simulations website and/or in the on-boarding documentation. – partially complete in that repositories and documentation should be sufficiently flexible to accommodate. Details of procedure to be done in future feature.

Update/refactor structure of simulation script repos in SKA Gitlab using hierarchical subgroups or otherwise (e.g. structure within a repo) to aid in discoverability of simulation scripts in GitLab.

Stretch: Simulation repos updated to report against CI metrics.

Socialise and review (with at least one other team on the ART) the process for contributing new SKA simulations to this space (if this feature is successful all future SKA simulations will be required to be added to this) – To be done in a future feature.
Show
Read-the-docs website (or equivalent) with suitable hierarchical structure that can be used to describe current and future SKA1 simulations. Simulations described by this should include: A short description of what the simulation does / is used for. A description of inputs, configuration, and any outputs that have already been generated The dependencies and requirements (including compute hardware) for running each simulation Description of how to contribute new simulations to this website and where scripts and simulation data (inputs and results) are be stored / hosted either as part of this simulations website and/or in the on-boarding documentation. – partially complete in that repositories and documentation should be sufficiently flexible to accommodate. Details of procedure to be done in future feature. Update/refactor structure of simulation script repos in SKA Gitlab using hierarchical subgroups or otherwise (e.g. structure within a repo) to aid in discoverability of simulation scripts in GitLab. Stretch: Simulation repos updated to report against CI metrics. Socialise and review (with at least one other team on the ART) the process for contributing new SKA simulations to this space (if this feature is successful all future SKA simulations will be required to be added to this) – To be done in a future feature.
Feature Points:
2
Initial Size:
2
WSJF:
16.5
Epic Link:
Instrumental Simulations
Agile Teams:

Team_SIM
Due Sprint:
Sprint 3
Story Point Burn-up:
Overdue:
Outcomes:

Hide

Simulation scripts have been collected in two repositories, one for Low and one for Mid:

https://gitlab.com/ska-telescope/ska-low-simulations
https://gitlab.com/ska-telescope/ska-mid-simulations

Each has a CI pipeline that lints the scripts.

The documentation will be available in the developer portal shortly (waiting for the System team to add them as sub-projects):

https://developer.skatelescope.org/projects/ska-low-simulations/en/latest/?badge=latest
https://developer.skatelescope.org/projects/ska-mid-simulations/en/latest/?badge=latest

Show
Simulation scripts have been collected in two repositories, one for Low and one for Mid: https://gitlab.com/ska-telescope/ska-low-simulations https://gitlab.com/ska-telescope/ska-mid-simulations Each has a CI pipeline that lints the scripts. The documentation will be available in the developer portal shortly (waiting for the System team to add them as sub-projects): https://developer.skatelescope.org/projects/ska-low-simulations/en/latest/?badge=latest https://developer.skatelescope.org/projects/ska-mid-simulations/en/latest/?badge=latest
Resolved PI.Sprint:
8.4

Feature Checklist:

Stories Completed, Outcomes Reviewed, Demonstrated, Accepted by FO

Demos:
- DP_ART_8.3
Requirement Status:

PI24 - UNCOVERED
Goals_MIRO:
SPO-687 SPO-721

Description

Single simulation script repository or repository groups using suitable GitLab sub-groups to improve discoverability and provide a well defined naming scheme for future simulation scripts.

This should result in future scripts reporting against software quality metrics (ie PEP-8, PEP-257 compliance) and include tests where possible (while it is understood that automated tests will not always be possible for simulation scripts, consider adding or describing an option to run with input configuration which verifies expected behaviour for a subset of the data).

Online documentation (eg using readthedocs) should provide a single entrypoint to discover what SKA simulations have been run, links to scripts, and outputs where appropriate.

Online documentation should also describe or link to all tools/codes being used for SKA simulations including sufficient information on input data (description and links to data in GCP), configuration, dependencies, and compute requirements sufficient to allow an advanced user (eg an SKA commissioning or system scientist) to repeat simulations with adjusted or additional inputs.

Attachments

Issue Links

relates to

SP-1328 Developer portal (top level) group for SDP workflow and simulation projects

Done

mentioned in: Page Loading...; Page Loading...; Page Loading...; Page Loading...; Page Loading...; Page Loading...; Page Loading...; Page Loading...; Page Loading...; Page Loading...; Page Loading...

(7 mentioned in)

Structure

Activity

People

Assignee:: Fenech, Danielle

Reporter:: Mort, Ben

Votes:: 0 Vote for this issue

Watchers:: 0 Start watching this issue

Feature Progress

Story Point Burn-up: (100.00%)

Feature Estimate: 2.0

	Issues	Story Points
To Do	0	0.0
In Progress	0	0.0
Complete	8	17.0
Total	8	17.0

Dates

Created:: 05/Aug/20 7:53 AM

Updated:: 17/Feb/24 1:24 PM

Resolved:: 03/Nov/20 2:44 PM

Establish online documentation (eg. readthedocs) and script repository for current and future SKA1 instrumental simulations