SciML / SciML/ModelingToolkitStandardLibrary.jl
Propagation of variable names and variable comments
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 171
- Forks
- 49
- Avg merge
- 15h 50m
- Merged PRs (30d)
- 10
Description
Our library components, like
Blocks.StateSpace
currently chooses names for, e.g., the input and output variables, u[1:3], y[1:2] etc.
I'd like to have to option to either provide these names upon construction or change them after construction:
u[1:3] -> [:fan_speed, :heater_duty_cycle, :solar_irradiance]
In addition, one could associate comments with variables like in modelica. This would be nice irrespective of the ability to prvide variable names since comments can contain much more information than a variable name
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Blocks.StateSpace component and examining how its input and output variables are currently named. Define how names and variable comments should be supplied or changed, then verify that the behavior applies to library components beyond the example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100