memilio icon indicating copy to clipboard operation
memilio copied to clipboard

Inconsistency and minor naming corrections across the library

Open mknaranja opened this issue 1 year ago • 1 comments

Motivation / Current Behaviour

Across the library, we still have a lot of inconsistencies and minor corrections that we would like to do.

They are

  • across models: some but not all of them can be harmonized as different models obviously differ...
  • inside models: the same objects appear with slightly different descriptions or documentations, parameter names are inconsistent, ...

However, many of these small naming changes touch many different files and thus produce merge conflicts with open pull requests.

Enhancement description

Here, I'd like you to collect all these small changes that we want to do. Then, we can check regularly if this change can be done without conflicting too much with open pull requests. As admins of the repository, @DavidKerkmann @HenrZu @jubicker @annawendler @xsaschako you are able to edit this message so that we can maybe collect all this here in one post.

For model harmonizations, please do identically at https://github.com/DLR-SC/memilio/issues/400

For now, we have

  • [ ] Make probability parameters in ODEs consistent: We have probabilities from all states to the next "worse" state in the course of the disease except for InfectedNoSymptoms where we have the probability to recover, i.e., RecoveredPerInfectedNoSymptoms. We should rather work with InfectedSymptomsPerInfectedNoSymptoms
  • [ ] Rename migration to mobility (for ABM #842)
  • [ ] Using TestAndTraceCapacity to calc riskFromInfectedNoSymptoms ... is missing in the ode_secir but implemented in the ode_secirvvs model.
  • [ ] Using ScalarType instead of double
  • [ ] Python ode examples are inconsistent (different ways using AgeGroups, Calling the infection states ....)

Additional context

No response

Checklist

  • [X] Attached labels, especially loc:: or model:: labels.
  • [X] Linked to project

mknaranja avatar Jul 19 '23 12:07 mknaranja

I'll do the renaming of migration to mobility in #687

jubicker avatar Aug 01 '23 09:08 jubicker