Skip to content

Improve the documentation of the IDE-SECIR model #976

@lenaploetzke

Description

@lenaploetzke

Motivation / Current Behaviour

Currently, the documentation in the README of the IDE-SECIR model is not very detailed.

Enhancement description

The documentation should be extended, especially by

  • a section on initialization
  • a diagram of the transitions (see also e.g. the ODE-SECIR model)
  • a table showing the parameters used

Checklist

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

Metadata

Metadata

Assignees

Labels

class::documentationImprovements or additions to documentationclass::improvementCleanup that doesn't affect functionalitymodel::ideThis issue concerns any kind of integro differential equations-based model.prio::highThe priority of this task is high.

Type

No type

Projects

Status

Done (Total)

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions