SciML / SciML/ComponentArrays.jl
Document Axis creating and multi-component indexing
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 375
- Forks
- 42
- Avg merge
- 7h 25m
- Merged PRs (30d)
- 17
Description
Are there examples, how multi-symbol indexing is currently done?
My use case for doing this indexing (using the proposed Axis-indexing (#132 )) is something like.
cv = ComponentVector(a=(a1=100,a2=(a21=210, a22=reshape(1:4,(2,2))),a3=300), b=3, c=4)
# extracting some of the nested a-components and the b component
# note that I do not explitely specify the structure of a2
cv_indextemplate = ComponentVector(a=(a2=1, a3=1), b=1)
ax = first(getaxes(cv_indextemplate)) # todo specify without template
cv_sub = cv[ax]
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 reviewing the proposed Axis-indexing work in issue #132 and the existing indexing examples in the repository. Document how to create an Axis and perform multi-symbol indexing, including the nested ComponentVector example shown here; done means the documented examples explain the intended extraction behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100