From 10c7149d74e857762cbbbbddf08041ce37e60f35 Mon Sep 17 00:00:00 2001 From: hk-2029 Date: Wed, 18 Mar 2026 15:12:40 +0000 Subject: [PATCH] docs: fix JDK version, update UKMOD wording, swap JAS-mine card for validation, enable instant nav, remove modifying-parameters from nav --- documentation/wiki/getting-started/data/index.md | 2 +- .../getting-started/data/tax-benefit-donors-uk.md | 2 +- documentation/wiki/getting-started/index.md | 2 +- documentation/wiki/index.md | 14 +++++++------- mkdocs.yml | 3 ++- 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/documentation/wiki/getting-started/data/index.md b/documentation/wiki/getting-started/data/index.md index 654e51dcb..565004450 100644 --- a/documentation/wiki/getting-started/data/index.md +++ b/documentation/wiki/getting-started/data/index.md @@ -29,7 +29,7 @@ In addition to training data, the model comes supplied with a set of Stata do fi SimPaths is designed to read in data describing tax-benefit payments generated by UKMOD. 1. Obtain a copy of the most recent version of UKMOD from the [CeMPA website](https://www.microsimulation.ac.uk/ukmod/access/). -2. Obtain the most recently available "b" series of input data provided for UKMOD as described on the CeMPA website. +2. Obtain the most recently available "Pooled 3-year FRS datasets for regional analysis ('b' datasets)" of input data provided for UKMOD using the FRS/LCF-based input data request form as described on the CeMPA website. 3. Run desired system years described by (1) UKMOD, using the (2) "b" series dataset - note that the same input data set should be used for all system years. System runs can be performed directly in UKMOD or calling UKMOD from STATA, R, or Python using the respective connectors. 4. Copy the files generated following (3) to model directory: `SimPaths/input/EUROMODoutput/`. Please note that it is required to provide UKMOD output files which include the base price year used by SimPaths (currently 2015). If no UKMOD output file is provided for the base price year, the initial database setup will fail. 5. Run SimPathsStart, and selection option "Load new input data for tax and benefit systems" from the Start-up Options window. \ No newline at end of file diff --git a/documentation/wiki/getting-started/data/tax-benefit-donors-uk.md b/documentation/wiki/getting-started/data/tax-benefit-donors-uk.md index f40244801..889e49a8d 100644 --- a/documentation/wiki/getting-started/data/tax-benefit-donors-uk.md +++ b/documentation/wiki/getting-started/data/tax-benefit-donors-uk.md @@ -3,7 +3,7 @@ SimPaths is designed to read in data describing tax-benefit payments generated by UKMOD. 1. Obtain a copy of the most recent version of UKMOD from the [CeMPA website](https://www.microsimulation.ac.uk/ukmod/access/). -2. Obtain the most recently available "b" series of input data provided for UKMOD as described on the CeMPA website. +2. Obtain the most recently available "Pooled 3-year FRS datasets for regional analysis ('b' datasets)" of input data provided for UKMOD using the FRS/LCF-based input data request form as described on the CeMPA website. 3. Run desired system years described by (1) UKMOD, using the (2) "b" series dataset - note that the same input data set should be used for all system years. System runs can be performed directly in UKMOD or calling UKMOD from STATA, R, or Python using the respective connectors. 4. Copy the files generated following (3) to model directory: `SimPaths/input/EUROMODoutput/`. Please note that it is required to provide UKMOD output files which include the base price year used by SimPaths (currently 2015). If no UKMOD output file is provided for the base price year, the initial database setup will fail. 5. Run SimPathsStart, and selection option "Load new input data for tax and benefit systems" from the Start-up Options window. \ No newline at end of file diff --git a/documentation/wiki/getting-started/index.md b/documentation/wiki/getting-started/index.md index 7597b2992..0b4ff07e4 100644 --- a/documentation/wiki/getting-started/index.md +++ b/documentation/wiki/getting-started/index.md @@ -6,7 +6,7 @@ This section walks you through everything needed to run SimPaths for the first t SimPaths is a Java project. Before running simulations you need: -- Java Development Kit (JDK) 11 or later +- Java Development Kit (JDK) 19 or later - Maven (for dependency management) - The required input data files (see [Input Data](data/index.md)) diff --git a/documentation/wiki/index.md b/documentation/wiki/index.md index 5a6d5222e..c403823b1 100644 --- a/documentation/wiki/index.md +++ b/documentation/wiki/index.md @@ -81,21 +81,21 @@ SimPaths builds upon **JAS-mine**, an open-source Java platform designed for dis Developer Guide → - +
- +
-

JAS-mine Reference

-

Statistical packages, alignment and matching libraries, regression tools, and database utilities.

-Reference → +

Model Validation

+

Validation procedures, alignment diagnostics, and comparison against external targets.

+Validation →
-

Research & Validation

-

Published papers, working papers, and model validation results.

+

Research

+

Published papers, working papers, and ongoing research using SimPaths.

Research → diff --git a/mkdocs.yml b/mkdocs.yml index a6d8d9baf..1a9023823 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,6 +32,8 @@ theme: icon: repo: fontawesome/brands/github features: + - navigation.instant + - navigation.instant.prefetch - navigation.tabs - navigation.tabs.sticky - navigation.sections @@ -112,7 +114,6 @@ nav: - Single Runs: user-guide/single-runs.md - Multiple Runs: user-guide/multiple-runs.md - Graphical User Interface: user-guide/gui.md - - Modifying Parameters: user-guide/modifying-parameters.md - Modifying Tax-Benefit Settings: user-guide/tax-benefit-parameters.md - Uncertainty Analysis: user-guide/uncertainty-analysis.md