Sienna-Platform / Sienna-Platform/InfrastructureOptimizationModels.jl

Generalize helpers for other axes

Open
#135 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
1
Forks
0
Avg merge
8h 51m
Merged PRs (30d)
9

Description

Consider generalizing our helpers to be compatible with containers with different axes: replace the pair of args name::String, t::Int and container[name, t] with ix::Tuple and container[ix...]. For example, outages are indexed by (outage_id, name, t). [However, there's not enough code reuse possible for outages alone such that it's clearly worth changing.]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the helpers that take name::String and t::Int, along with their container[name, t] call sites, and inspect how outage indexing differs. Determine whether tuple-based indexing provides useful reuse beyond outages; done means a justified generalization with existing helper behavior preserved.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.