8000 Install SimDB export/comparator scripts for MAP v2.1 release by colby-nyce · Pull Request #578 · sparcians/map · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Install SimDB export/comparator scripts for MAP v2.1 release #578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
May 28, 2025
Merged

Install SimDB export/comparator scripts for MAP v2.1 release #578

merged 6 commits into from
May 28, 2025

Conversation

colby-nyce
Copy link
Contributor

This PR gets everything ready for map_v2.1 where we will want an easy way for users to try out SimDB reports and check for backwards compatibility. The main idea here is that we need simdb_export / simdb_compare to be in Conda on the search path for the easiest verification workflow:

# v2 workflow still supported
./sim -i 10k --report stats.yaml 

# Try out SimDB (omitting --simdb-file just defaults to using "sparta.db")
./sim -i 10k --report stats.yaml --enable-simdb-reports
simdb_compare sparta.db

### Prints out something like:
###   7 passed, 0 failed.
###   Comparison results saved to simdb-comparison-results/comparison_results.txt
###
### Note the simdb-comparison-results directory contains the legacy reports, SimDB reports, sparta.db, and a log file.
### Users will decide how to report any discrepancies (data might be sensitive).

# If the comparison script says everything is the same, the new workflow in v2.1+ would be:
./sim -i 10k --report stats.yaml --enable-simdb-reports --disable-legacy-reports
simdb_export sparta.db

### Prints out something like:
###   Exported: ./autopop_update_count.csv
###   Exported: ./global_cumulative_stats.csv
###   Exported: ./global_stats.csv

# Starting in map_v3, SimDB will be the default (assume --simdb-file now used)
./sim -i 10k --report stats.yaml --simdb-file stats.db
simdb_export stats.db

It is an open question whether we provide a fallback to re-enable legacy reports in v3, something like:

./sim -i 10k --report stats.yaml --simdb-file stats.db --enable-legacy-reports

We probably do want that option, but eventually in map_v3 we will actually delete all the old report formatter code forever!

@colby-nyce colby-nyce requested a review from klingaard May 23, 2025 21:05
@colby-nyce colby-nyce merged commit 4923b7c into master May 28, 2025
9 checks passed
@colby-nyce colby-nyce deleted the colby-nyce/simdb-verif-v2.1 branch May 28, 2025 22:01
github-actions bot pushed a commit that referenced this pull request May 28, 2025
@colby-nyce
[ci skip] Install SimDB export/comparator scripts for MAP v2.1 release (
06c6305 
#578)

* Install SimDB export/comparator scripts for MAP v2.1 release

* Fix report unit test (no simulation)

* Touch simdb_export.py

* Fix SimInfo report discrepancies. Do not save reports from destructor.

* PR feedback

* Improve CSV export perf by 10% 4923b7c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@klingaard klingaard klingaard approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@colby-nyce @klingaard
0