Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

des/2506-changes-to-simulation-project-type #1097

Merged
merged 3 commits into from
Oct 2, 2023

Conversation

van-go
Copy link
Contributor

@van-go van-go commented Sep 21, 2023

Overview:

Text and functionality changes to Simulation project type.

PR Status:

  • Ready.
  • Work in Progress.
  • Hold.

Related Jira tickets:

Summary of Changes:

  • Require the description for Simulation Model
  • Require the Report category
  • Change the definitions for the categories:

Model: Information and/or files describing the design, geometry, workflow, runtime environment and/or code of a simulation. This includes referencing research software or a community model and version when applicable.
Input: Files and references to the files containing the parameters of the simulation.
Output: Files containing the results of a simulation.
Report: Detailed written account/s to convey information about the way in which the simulation was organized, how to run it, about the file contents and the file naming convention used. It could be one or a group of files including a readme file and a data dictionary, depending on the complexity and components of the simulation.
Analysis: Tables, graphs, visualizations, Jupyter Notebooks, or other representations of the results.

  • Add the definition of a Simulation to the top of the Add Simulations modal (like the category definitions in Add Categories):

Simulation: A stand-alone dataset published under a unique citation and DOI. One or more can be published under a project and each can be published progressively and versioned.

Testing Steps:

Any Simulation

  1. Notice text changes under 'Add Simulations' and 'Add Categories'

New Simulation

  1. When adding a Sim Model, notice that a description is required.
  2. When trying to publish, notice that a Report is now required.

Amend/Revision

  1. Make sure the above changes and requirements are working properly for amends/revisions

UI Photos:

Screen Shot 2023-09-20 at 4 36 53 PM
Screen Shot 2023-09-20 at 10 21 17 PM
Screen Shot 2023-09-20 at 10 21 53 PM
Screen Shot 2023-09-20 at 10 23 34 PM

Notes:

Copy link
Member

@jarosenb jarosenb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for wording changes!

@jarosenb jarosenb merged commit a0a3762 into main Oct 2, 2023
2 checks passed
@jarosenb jarosenb deleted the task/des-2506-changes-to-simulation branch October 2, 2023 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants