More docs

Author: yamilbknsu

configuration/demos_config.toml

@@ -80,7 +80,7 @@ index_col = "year"
 # Modules configuration
 [employment_module_config.simultaneous_calibration_config]
 tolerance = 100
-max_iter = 2
+max_iter = 20
 learning_rate = 2
 momentum_weight = 0.3
 
@@ -89,7 +89,7 @@ momentum_weight = 0.3
 procedure_type = "rmse_error"
 tolerance_type = "absolute"
 tolerance = 1000
-max_iter = 2 # 1000
+max_iter = 1000
 [mortality_module_config.calibration_procedure.observed_values_table]
 file_type = "csv"
 table_name = "observed_fatalities_data"
@@ -101,7 +101,7 @@ index_col = "year"
 procedure_type = "rmse_error"
 tolerance_type = "absolute"
 tolerance = 1000
-max_iter = 2 # 1000
+max_iter = 1000
 [birth_module_config.calibration_procedure.observed_values_table]
 file_type = "csv"
 table_name = "observed_births_data"
@@ -113,8 +113,8 @@ index_col = "year"
 geoid_col = "lcm_county_id"
 
 [hh_reorg_module_config.simultaneous_calibration_config]
-tolerance = 1_000
-max_iter = 2 # 100
+tolerance = 5_000
+max_iter = 100
 learning_rate = 2.5
 momentum_weight = 0.3
 

docs/source/conf.py

@@ -67,6 +67,7 @@
     "deflist",
     "html_admonition",
     "html_image",
+    "colon_fence"
 ]
 
 # Sphinx multiversion config

docs/source/pages/intro.md

@@ -2,6 +2,14 @@
 
 DEMOS is a modular demographic microsimulator. It operates on tabular data representing agents or entities (primarily persons and households), and is configured via a simple TOML file. DEMOS can be run from source or using Docker for reproducibility.
 
+This document summarizes instructions to install, configure and run DEMOS. Sections 1-4 will help you correctly organize the data and configuration file, so we recommend reading them once before attempting to run DEMOS.
+
+```{contents}
+:local:
+:depth: 2
+:backlinks: none
+:class: this-will-duplicate-information-and-it-is-still-useful-here
+```
 
 ## 1. Installation
 
@@ -23,14 +31,14 @@ DEMOS is a modular demographic microsimulator. It operates on tabular data repre
 
 1. **Run with Docker Compose**:
     ```bash
-    docker-compose up
+    docker compose up
     ```
 
     By default, this assumes that your config file is located in `./configuration/demos_config.toml` and the data folder is `./data`, with `./` being the root of the project (See the [file stucture section](#file-tree-structure-for-data-and-configuration) for details on how to organize the input data).
     If you need to specify a different location for them, you can run:
 
     ```bash
-    DEMOS_CONFIG_PATH=<path-to-config> DEMOS_DATA_DIR=<path-to-data-dir> docker-compose up
+    DEMOS_CONFIG_PATH=<path-to-config> DEMOS_DATA_DIR=<path-to-data-dir> docker compose up
     ```
 
 1. **Or run with Docker directly**: