Skip to content

Update small example data#84

Merged
yamilbknsu merged 7 commits intomainfrom
dev
Mar 2, 2026
Merged

Update small example data#84
yamilbknsu merged 7 commits intomainfrom
dev

Conversation

@yamilbknsu
Copy link
Collaborator

Integrate the work of small example data into the main branch

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request integrates small example data into the main branch, replacing the SF Bay example as the default configuration for new users. The changes make the project more accessible by providing a smaller, faster-running example dataset for users getting started with DEMOS.

Changes:

  • Updates documentation (README.md and intro.md) to point to the new small example configuration file instead of the SF Bay example
  • Improves calibration documentation by clarifying how to skip calibration procedures
  • Adds max_iter safeguard to the kids_moving calibration loop to prevent infinite iterations
  • Adds comprehensive small example data files including observed calibration values and pre-calibrated model coefficients
  • Removes SF Bay example observed calibration data files (keeping only the main dataset)
  • Updates configuration to use the small example data with adjusted calibration parameters

Reviewed changes

Copilot reviewed 25 out of 37 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/source/pages/intro.md Updated curl command to download small example config instead of SF Bay config
docs/source/pages/advanced_configuration.md Improved documentation on skipping calibration with better formatting and clearer instructions
demos/models/kids_moving.py Added max_iter check to calibration loop to prevent infinite iterations
demos/config.py Added max_iter field to KidsMovingModuleConfig with default value of 100
data/small_example/* Added comprehensive small example data including relational mapping, observed calibration values, and pre-calibrated model coefficients
data/sf_bay_example/observed_calibration_values/* Removed observed calibration CSV files (main dataset files remain)
data/.gitignore Added small_example directory to whitelist for version control
configuration/demos_config_small_example.toml Updated paths and parameters for small example dataset
README.md Updated curl command to download small example config instead of SF Bay config
Comments suppressed due to low confidence (3)

configuration/demos_config_small_example.toml:36

  • The inline comment listing alternative file paths (custom_mpo_06197001_model_data_small.h5, minihh.h5, etc.) could be confusing for users. These alternative paths may be outdated or not exist, and could mislead users into thinking they need to use one of these files. Consider removing these comments or clearly marking them as "examples" or "deprecated options" if they serve a documentation purpose.
    configuration/demos_config_small_example.toml:42
  • Similar to line 36, the inline comment listing alternative file paths could be confusing for users. Consider removing or clarifying these comments to avoid confusion about which file should actually be used.
    configuration/demos_config_small_example.toml:133
  • The calibration_tolerance value of 0.01 is 10 times larger than the default value of 0.001 defined in config.py. While this might be intentional for the small example dataset to achieve faster convergence, it results in less precise calibration. Consider adding a comment explaining why a larger tolerance is acceptable for this example, or verify that this increased tolerance is appropriate for the small example data.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@yamilbknsu yamilbknsu merged commit b5af542 into main Mar 2, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants