-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add first draft of stock and flow schema and example #61
Conversation
Co-authored-by: Brandon Rose <[email protected]> Co-authored-by: liunelson <[email protected]> Co-authored-by: Matthew Printz <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me
Question: How do we represent a flow that upstreams or downstreams from/to a "cloud" rather than a defined stock? |
I think the placeholder for the "cloud" would just be left empty, i.e., |
"links": { | ||
"type": "array", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can foresee us needed to include additional information on the links, such as "color"/"category", "polarity", "label", etc.
I am not sure which, if any, of these should be included in the schema or if we should just include a meta
/extras
property to store any of this extra information.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would put any of those keys under an optional properties
block.
That sounds right. In terms of the schema: there haven't been any further comments since I posted this 2 weeks ago to request changes so I think we'll go with what we have here. |
@@ -1,7 +1,7 @@ | |||
{ | |||
"header": { | |||
"name": "SIR Model", | |||
"schema": "", | |||
"schema": "https://raw.githubusercontent.com/DARPA-ASKEM/Model-Representations/stock-flow/stockflow/stockflow_schema.json", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good temporary addition, thanks! We will ideally change this to a tagged version URL once the PR is merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mwdchang pointed this out so I made this change so we pass all the checks for merger!
This is a proposed stock and flow AMR which reuses as many components as possible from existing AMRs while following the overall structure of the stock and flow ACSet.