From bf1a925c68a76e7dddf311a06f57eaa3734ec6ca Mon Sep 17 00:00:00 2001 From: Anita Applegarth Date: Wed, 22 Jan 2025 10:16:49 +0000 Subject: [PATCH] Style change for instructions --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3d525bc..87cd945 100644 --- a/README.md +++ b/README.md @@ -19,19 +19,20 @@ To model an epidemic, contact events are represented by the population spatial s ## Running a simulation -The basic flow of a simulation is described below and an overview of the process is illustrated in Figure 4. The instructions to run a basic simulation is also given; we will use 'Andorra' as the region of interest. A more detailed, complex example is illustrated in this jupyter notebook (ADD LINK). Also, [the Wiki](https://github.com/SABS-R3-Epidemiology/epiabm/wiki/Overview-of-the-Ferguson-Model) details optional parameters available to the user as well as those whose values are mentioned, but changing them is not recommended. +The basic flow of a simulation is described below and an overview of the process is illustrated in Figure 3. The instructions to run a basic simulation is also given; we will use 'Andorra' as the region of interest. A more detailed, complex example is illustrated in this jupyter notebook (ADD LINK). Also, [the Wiki](https://github.com/SABS-R3-Epidemiology/epiabm/wiki/Overview-of-the-Ferguson-Model) details optional parameters available to the user as well as those whose values are mentioned, but changing them is not recommended.
Overview of simulation workflow -
Figure 4. Overview of simulation workflow: These steps are required to run a simulation.
+
Figure 3. Overview of simulation workflow: These steps are required to run a simulation.
### Step 1: Set up rEpiabm Before running a simulation, rEpiabm needs to be installed with all dependencies mentioned in the DESCRIPTION file. Also, the folder structure used by the R program file needs to be set up for your region of interest. - -**Instructions:** -1. Go to your github personal Settings/Developer Settings +
+Instructions: +
    +
  1. 1. Go to your github personal Settings/Developer Settings 2. Create a new personal access token (fine-grained) 3. Launch RStudio and type: ```file.edit("~/.Renviron")``` @@ -48,7 +49,10 @@ Before running a simulation, rEpiabm needs to be installed with all dependencies install.packages("devtools") devtools::install_github("SABS-R3-Epidemiology/rEpiabm") ``` -7. Copy the example 'Andorra' folder structure within the data folder and name it with your region of interest (include the files as you will need to edit these for your simulation). +7. Copy the example 'Andorra' folder structure within the data folder and name it with your region of interest (include the files as you will need to edit these for your simulation).
  2. +
+
+ You are now ready to configure a simulation.