Covasim Logo
latest
  • Covasim overview
  • Tutorials
  • Covasim papers
  • FAQ
  • What’s new
  • Parameters
  • Data scrapers
  • Glossary
  • Code of conduct
  • Contributing to Covasim
  • Style guide
  • API reference
    • Subpackages
      • covasim.data package
    • Submodules
      • covasim.analysis module
      • covasim.base module
      • covasim.defaults module
      • covasim.immunity module
      • covasim.interventions module
      • covasim.misc module
      • covasim.parameters module
      • covasim.people module
      • covasim.plotting module
      • covasim.population module
      • covasim.requirements module
      • covasim.run module
      • covasim.settings module
      • covasim.sim module
      • covasim.utils module
      • covasim.version module
Covasim
  • Covasim website »
  • Documentation »
  • API reference
  • Edit on GitHub

API reference¶

Initialize Covasim by importing all the modules

Convention is to use “import covasim as cv”, and then to use all functions and classes directly, e.g. cv.Sim() rather than cv.sim.Sim().

Subpackages¶

  • covasim.data package
    • Submodules
      • covasim.data.country_age_data module
      • covasim.data.household_size_data module
      • covasim.data.loaders module
      • covasim.data.state_age_data module

Submodules¶

  • covasim.analysis module
  • covasim.base module
  • covasim.defaults module
  • covasim.immunity module
  • covasim.interventions module
  • covasim.misc module
  • covasim.parameters module
  • covasim.people module
  • covasim.plotting module
  • covasim.population module
  • covasim.requirements module
  • covasim.run module
  • covasim.settings module
  • covasim.sim module
  • covasim.utils module
  • covasim.version module
Next Previous

© Copyright 1999 - 2022, Bill & Melinda Gates Foundation. All rights reserved. These docs were built for Covasim version 3.1.4. Revision d3b3aa60.

Covasim is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

Send documentation feedback to [email protected]. If you have questions, email [email protected].

Privacy and Cookies Notice   |    Terms of Use

Read the Docs v: latest
Versions
latest
Downloads
pdf
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.