Quick Start Guide

Note

Please make sure you have installed metawards, e.g. by following these installation instructions. You can test this by typing metawards --version on the terminal/console. Note that this should show that MetaWardsData has been found. If you have not installed MetaWardsData then you need to install it by following these instructions.

You have three choices for how you use MetaWards, and thus three choices for how you will follow this quick start guide;

1. R interface. You can choose to use MetaWards from directly within R (including interactively, e.g. within RStudio).

2. Python interface. You can choose to use MetaWards from directly within Python (including interactively, e.g. within ipython or Jupyter notebook or lab).

3. Command-line interface. You can choose to use MetaWards from the command line (terminal/console/command prompt).

There is no one right or wrong interface to use, so please feel free to use the one (or many) that fit your needs.

This quick start should take about 30 minutes to follow. It is a precursor to the detailed tutorial. If you want to learn more, please follow that tutorial, or read the detailed API documentation. Please choose to follow either the R, Python and console versions.

R / RStudio

• Getting Started in R
  • Prerequisites
  • Creating the disease
  • Creating the wards (network)
  • Running the model
  • Seeding the outbreak
  • Visualising the results
  • Complete code
• Extending the Model in R
  • Adding a disease stage
  • Repeating a run
  • Adding more wards
  • Running the model
  • Complete code
• Multiple pathways with R
  • Creating a mild disease
  • Creating the networks
  • Creating the demographics
  • Running the model
  • Complete code
  • What’s next?

Python / Jupyter

• Getting Started in Python
  • Prerequisites
  • Importing metawards
  • Creating the disease
  • Creating the wards (network)
  • Running the model
  • Seeding the outbreak
  • Visualising the results
  • Complete code
• Extending the Model in Python
  • Adding a disease stage
  • Repeating a run
  • Adding more wards
  • Running the model
  • Complete code
• Multiple pathways with Python
  • Creating a mild disease
  • Creating the networks
  • Creating the demographics
  • Running the model
  • Complete code
  • What’s next?

Console / Command line

• Getting Started in the Console
  • Prerequisites
  • Creating the disease
  • Creating the wards (network)
  • Running the model
  • Seeding the outbreak
  • Visualising the results
• Extending the Model in the Console
  • Adding a disease stage
  • Repeating a run
  • Adding more wards
  • Running the model
• Multiple pathways with Python
  • Creating a mild disease
  • Creating the networks
  • Creating the demographics
  • Running the model
  • What’s next?

Next steps

Go to the tutorial to learn more.