Conversation
…tation upgrade
- model-concepts.md: remove Modules in depth (redundant with website), compress intro, remove Key input files table, trim EUROMOD section; keep agent hierarchy with code-level attributes, process order table, alignment flags table, and IO/intertemporal explanations - data-and-outputs.md: replace flat list with directory tree, remove reg_/align_ file listing (covered by parameterisation page), add pointer to variable codebook for output CSV descriptions - README.md: add one-liner clarifying scope vs website, remove redundant Scope section - scenario-cookbook.md: note that model_args keys map to @GUIparameter fields on SimPathsModel - wiki/getting-started/environment-setup.md: fix Java version (19, not 11) and build command (mvn clean package, not install -DskipTests) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- config/default.yml: add inline comment for every field, including exact numeric behavior for innovation_args shocks and S-Index parameter meanings - documentation/configuration.md: replace flat bullet lists with tables; add S-Index explanation, full innovation_args behavior (seed increment, ±0.0075 interest rate, ±0.01 income shock), and clear Statistics1/2/3/Employment/Health file descriptions Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- scenario-cookbook.md: correct that custom configs inherit from class field defaults, not from default.yml; fix readGrid comment (not set automatically — must be set manually to match the output folder name) - data-and-outputs.md: expand compile/ description to reflect the full data pipeline; add CSV naming convention note (EntityClass + RunNumber) and inline descriptions for each output file - validation-guide.md: new file documenting the two-stage validation workflow (9 estimate-validation scripts + 28 simulated-output scripts, setup instructions, interpretation guidance) - data-pipeline.md: new file documenting the full chain from raw UKHLS/BHPS/WAS/EUROMOD data to simulation-ready inputs, with per-script tables for all three parts and a when-to-re-run guide - README.md: add data-pipeline.md and validation-guide.md to reading list - config/default.yml: correct flagDefaultToTimeSeriesAverages default to false
…t just a small subset
…ing-started and development - New repository-structure.md with full directory tree - Prerequisites and quick run consolidated into configuration.md - Training mode info moved to repository-structure.md - Condensed 99_training_data.do table entry in data-pipeline.md - Removed country variants reference from README.md
Expanded the file organization section to provide a detailed directory structure and descriptions of contents for the SimPaths repository. Updated the source code and input data sections to clarify their purposes and organization.
Removed Repository Structure and CLI Reference from recommended reading order.
Updated the documentation for file organization, setup-generated artifacts, training mode, and logging.
- Add docs_dir: documentation/wiki to mkdocs.yml so MkDocs finds the source files - Fix deploy-docs.yml path filter from docs/** to documentation/wiki/** - Website now auto-deploys on push to main when wiki files change
…ata pipeline only
…tation Update documentation & website
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.