Merge branch 'main' into 55-output-formats-python

.github/workflows/pages.yml

@@ -1,6 +1,9 @@
 name: Deploy site
 
-on: [push]
+on:
+  push:
+    branches:
+      - main
 
 jobs:
   build:
@@ -37,4 +40,4 @@ jobs:
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ./docs/_book
-        keep_files: true
+        keep: false

README.md

@@ -6,9 +6,9 @@
 
 <img src="docs/logo_SPC_Black.png" align="left" width="130"/>
 
-The Synthetic Population Catalyst (SPC) makes it easier for researchers to work with synthetic population data in England. It combines a variety of [data sources](https://alan-turing-institute.github.io/uatk-spc/data_sources.html) and outputs a single file in [protocol buffer format](https://github.com/alan-turing-institute/uatk-spc/blob/main/synthpop.proto), describing the population in a given study area, with a particular focus on socio-economic characteristics and interactions between individuals. It is therefore well suited to create inputs for models studying the spreading of a pandemic or segregation (e.g.). The tool provides methods to export the outcome in diferent formats often use for researchers like CSV or JSON.
+The Synthetic Population Catalyst (SPC) makes it easier for researchers to work with synthetic population data in England. It combines a variety of [data sources](https://alan-turing-institute.github.io/uatk-spc/understanding_data_sources.html) and outputs a single file in [protocol buffer format](https://github.com/alan-turing-institute/uatk-spc/blob/main/synthpop.proto), describing the population in a given study area, with a particular focus on socio-economic characteristics and interactions between individuals. It is therefore well suited to create inputs for models studying the spreading of a pandemic or segregation (e.g.). The tool provides methods to export the outcome in diferent formats often use for researchers like CSV or JSON.
 
-The input of the SPC tool is a list of the Middle Layer Super Output Area (MSOAs) where you want to create a spatially enriched sythetic population to feed other dynamic models. SPC includes a script to assist you with the proper list of the MSOAs by defining a Local Authority District area in England. [Get started](https://alan-turing-institute.github.io/uatk-spc/) to download SPC data or run the tool in different MSOAs.
+The input of the SPC tool is a list of the Middle Layer Super Output Area (MSOAs) where you want to create a spatially enriched sythetic population to feed other dynamic models. SPC includes a script to assist you with the proper list of the MSOAs by defining a Local Authority District area in England. [Get started](https://alan-turing-institute.github.io/uatk-spc/using_getting_started.html) to download SPC data or run the tool in different MSOAs.
 
 
 ## Lineage
@@ -29,4 +29,4 @@ version control history can be seen on Github in the other repositories.
 
 ## Ethical considerations
 
-Synthetic data may propagate biases existing in the real data it is based on, introduce new ones, or remove useful outliers. See [ONS ethical guidance](https://uksa.statisticsauthority.gov.uk/publication/ethical-considerations-relating-to-the-creation-and-use-of-synthetic-data/pages/1/) for more details. SPC is based on a collection of different 'modelling modules', including some developed externally by other researchers. Each module is validated independently. Validation for newly created methods and links to previous projects can be found in the [modelling methods](https://alan-turing-institute.github.io/uatk-spc/modelling_methods.html).
+Synthetic data may propagate biases existing in the real data it is based on, introduce new ones, or remove useful outliers. See [ONS ethical guidance](https://uksa.statisticsauthority.gov.uk/publication/ethical-considerations-relating-to-the-creation-and-use-of-synthetic-data/pages/1/) for more details. SPC is based on a collection of different 'modelling modules', including some developed externally by other researchers. Each module is validated independently. Validation for newly created methods and links to previous projects can be found in the [modelling methods](https://alan-turing-institute.github.io/uatk-spc/understanding_modelling_methods.html).

docs/_quarto.yml

@@ -10,23 +10,27 @@ book:
     - index.qmd
     - part: "Using SPC"
       chapters:
-        - outputs.qmd
-        - england_outputs.qmd
-        - wales_outputs.qmd
-        - scotland_outputs.qmd
-        - use_output.qmd
-        - installation.qmd
-        - custom_areas.qmd
+        - using_getting_started.qmd
+        - using_outputs.qmd
+        - using_england_outputs.qmd
+        - using_wales_outputs.qmd
+        - using_scotland_outputs.qmd
+        - using_use_output.qmd
+        - using_installation.qmd
+        - using_custom_areas.qmd
     - part: "Understanding SPC"
       chapters:
-        - schema.qmd
-        - modelling_methods.qmd
-        - data_sources.qmd
+        - understanding_introduction.qmd
+        - understanding_technical_overview.qmd
+        - understanding_modelling_methods.qmd
+        - understanding_data_schema.qmd
+        - understanding_data_sources.qmd
+    - validation.qmd
     - part: "Advanced"
       chapters:
-        - developer_guide.qmd
-        - code_walkthrough.qmd
-        - performance.qmd
+        - advanced_developer_guide.qmd
+        - advanced_code_walkthrough.qmd
+        - advanced_performance.qmd
 
 format:
   html: