ukaea / ukaea/PROCESS

Variable restructuring

Open
#4,248 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic
Dominant language
Python
Stars
71
Forks
27
Avg merge
2d 18h
Merged PRs (30d)
33

Description

This is the overarching epic for sorting out the variables into more descriptive, more modular dataclasses.
Eg there exists fwbs_variables.py, blanket_variables.py and fw_variables.py, and the variables in fwbs should be split into blanket, fw and a new shield class instead.

#3822 is an initial example of a piece of this work

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

Start by reading fwbs_variables.py, blanket_variables.py, and fw_variables.py, then review issue #3822 as the initial example of this restructuring. Map which variables belong in blanket, fw, and the proposed shield dataclass; the epic is complete when the variables are separated into more descriptive, modular dataclasses.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.