Skip to content

Inconsistency and minor naming corrections across the library #704

@mknaranja

Description

@mknaranja

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 #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 change wording: replace abm migration by mobility and epi by mio #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

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

Metadata

Metadata

Labels

Epicclass::documentationImprovements or additions to documentationclass::improvementCleanup that doesn't affect functionalityloc::backendThis issue concerns the C++ backend implementation.loc::data analysisThis issue concerns any kind of data analysis.loc::python interfaceThis issue concerns the python interface to the backend implementation.model::abmThis issue concerns any kind of agent-based model.model::ideThis issue concerns any kind of integro differential equations-based model.model::mlmachine learning surrogate modelmodel::odeThis issue concerns any kind of ODE-based model.

Type

No type

Projects

Status

EPIC 🌋

Status

Product Backlog

Status

Product Backlog

Status

📋 Product backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions