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

[UNDER-DISCUSSION] Standardize the way to handle input files for Codes #1240

Closed
5 of 10 tasks
wangcj05 opened this issue May 20, 2020 · 3 comments
Closed
5 of 10 tasks
Assignees
Labels
archive To archive the feature requests or PRs when there are no further developments priority_minor task This tag should be used for any new capability, improvement or enanchment

Comments

@wangcj05
Copy link
Collaborator

wangcj05 commented May 20, 2020


Issue Description

Currently, there are no specific links between the input files and codes, especially for HybridModel, LogicalModel, EnsembleModel and CodeInterfaces. We need to standardize the way to handle this situation to increase the usability of the code.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.


For Change Control Board: Issue Review

This review should occur before any development is performed as a response to this issue.

  • 1. Is it tagged with a type: defect or task?
  • 2. Is it tagged with a priority: critical, normal or minor?
  • 3. If it will impact requirements or requirements tests, is it tagged with requirements?
  • 4. If it is a defect, can it cause wrong results for users? If so an email needs to be sent to the users.
  • 5. Is a rationale provided? (Such as explaining why the improvement is needed or why current code is wrong.)

For Change Control Board: Issue Closure

This review should occur when the issue is imminently going to be closed.

  • 1. If the issue is a defect, is the defect fixed?
  • 2. If the issue is a defect, is the defect tested for in the regression test system? (If not explain why not.)
  • 3. If the issue can impact users, has an email to the users group been written (the email should specify if the defect impacts stable or master)?
  • 4. If the issue is a defect, does it impact the latest release branch? If yes, is there any issue tagged with release (create if needed)?
  • 5. If the issue is being closed without a pull request, has an explanation of why it is being closed been provided?
@wangcj05 wangcj05 added priority_minor task This tag should be used for any new capability, improvement or enanchment labels May 20, 2020
@wangcj05 wangcj05 self-assigned this May 20, 2020
@wangcj05 wangcj05 mentioned this issue May 20, 2020
9 tasks
@wangcj05
Copy link
Collaborator Author

wangcj05 commented Jun 3, 2020

Based on the raven team discussion, we also need to make some improvement on the Dummy Inputs that are currently required, but not actually used by the code.

@wangcj05
Copy link
Collaborator Author

Several options:

  1. addition attribute for Input under Steps:
    image
    May require significant modifications.
  2. addition attribute for Input under Files:
    image
    Minor modifications, but same input file can not be used for multiple models
  3. addition node under Codes
    Code block can not be reused by other steps with different input files.

@wangcj05 wangcj05 changed the title [TASK] Standardize the way to handle input files for Codes [UNDER-DISCUSSION] Standardize the way to handle input files for Codes Jun 16, 2020
@wangcj05 wangcj05 added the archive To archive the feature requests or PRs when there are no further developments label May 24, 2022
@wangcj05
Copy link
Collaborator Author

archived

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
archive To archive the feature requests or PRs when there are no further developments priority_minor task This tag should be used for any new capability, improvement or enanchment
Projects
None yet
Development

No branches or pull requests

2 participants