Add a ModelState class

[atharva-2001]

Description

Motivation and context

How has this been tested?

• Testing pipeline.
• Other.

Examples

Type of change

• Bug fix.
• New feature.
• Breaking change.
• None of the above.

Checklist

• My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • (optional) I have built the documentation on my fork following the instructions.
• I have assigned and requested two reviewers for this pull request.

[codecov]

Codecov Report

Merging #1847 (5ef235b) into master (c34beca) will increase coverage by 4.17%.
The diff coverage is n/a.

❗ Current head 5ef235b differs from pull request most recent head 1c4e1fe. Consider uploading reports for the commit 1c4e1fe to get more accurate results

@@            Coverage Diff             @@
##           master    #1847      +/-   ##
==========================================
+ Coverage   58.04%   62.21%   +4.17%     
==========================================
  Files          66       66              
  Lines        6747     6826      +79     
==========================================
+ Hits         3916     4247     +331     
+ Misses       2831     2579     -252     

Impacted Files	Coverage Δ
...dis/montecarlo/montecarlo_numba/numba_interface.py	35.46% <0.00%> (-10.69%)	⬇️
tardis/tardis/analysis.py	30.16% <0.00%> (ø)
...rdis/tardis/montecarlo/montecarlo_configuration.py	100.00% <0.00%> (ø)
tardis/tardis/montecarlo/base.py	88.94% <0.00%> (+0.17%)	⬆️
tardis/tardis/simulation/base.py	83.79% <0.00%> (+0.46%)	⬆️
tardis/tardis/model/base.py	88.96% <0.00%> (+0.66%)	⬆️
.../montecarlo/montecarlo_numba/single_packet_loop.py	29.78% <0.00%> (+2.66%)	⬆️
tardis/tardis/montecarlo/montecarlo_numba/base.py	32.14% <0.00%> (+5.92%)	⬆️
tardis/tardis/visualization/plot_util.py	100.00% <0.00%> (+6.25%)	⬆️
tardis/tardis/base.py	75.00% <0.00%> (+17.85%)	⬆️
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c34beca...1c4e1fe. Read the comment docs.

[wkerzendorf]

you want to initialize it with the variables as discussed

[atharva-2001]

Is 2e58f01 a good way to do this? Because properties are very related to each other, I thought it might be good to move those calculations to model_state class.

[tardis-bot]

Before a pull request is accepted, it must meet the following criteria:

• Is the necessary information provided?
• Is this a duplicate PR?
  • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
  • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
• Does it pass existing tests and are new tests provided if required?
  • The test coverage should not decrease, and for new features should be close to 100%.
• Is the code tidy?
  • No unnecessary print lines or code comments.

[andrewfullard]

I think the class looks good, though it should in the future probably act as a base class for the Radial1DModel. Currently, the ModelState assumes 1D as well. Unclear if we want to generalise more right now.

[wkerzendorf]

@atharva-2001 can you check the docststrings - but then it is good to merge.