468 ABM parameter study #1395

reneSchm · 2025-10-14T20:13:38Z

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

Simplify ParameterStudy, so it can use any parameter type and more generic simulations.
- This strongly changes the class layout and usage.
Add example for an ABM study.
Usage and behavior in python bindings is mostly unchanged.

If need be, add additional information and what the reviewer should look out for in particular:

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
New code adheres to coding guidelines
No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
Tests are added for new functionality and a local test run was successful (with and without OpenMP)
Appropriate documentation within the code (Doxygen) for new functionality has been added in the code
Appropriate external documentation (ReadTheDocs) for new functionality has been added to the online documentation
Proper attention to licenses, especially no new third-party software with conflicting license has been added
(For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

Corresponding issue(s) is/are linked and addressed
Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

…nto abm-parameter-study

codecov · 2025-10-22T10:57:13Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.27%. Comparing base (aa541c0) to head (5c03d29).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1395      +/-   ##
==========================================
+ Coverage   97.25%   97.27%   +0.02%     
==========================================
  Files         176      182       +6     
  Lines       15466    15652     +186     
==========================================
+ Hits        15041    15226     +185     
- Misses        425      426       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

this allows deduction of template arguments from the constructor, making the make_parameter_study functions obsolete. the simulation type is now deduced from the create_simulation argument, and checks on invocability have been moved to clean up deduced types. Add documentation.

This reverts commit ea3acde.

cpp/examples/abm_parameter_study.cpp

cpp/memilio/utils/index.h

cpp/models/abm/model.h

cpp/tests/test_abm_simulation.cpp

cpp/tests/test_io_cli.cpp

cpp/tests/test_parameter_studies.cpp

Co-authored-by: annawendler <106674756+annawendler@users.noreply.github.com>

cpp/examples/abm_parameter_study.cpp

cpp/memilio/compartments/parameter_studies.h

MaxBetzDLR

Changes for documentation of python bindings

MaxBetzDLR · 2025-11-13T14:56:31Z

pycode/memilio-simulation/memilio/simulation/bindings/models/osecir.cpp

 */
-template <class Simulation>
+template <class Sim>
 void bind_ParameterStudy(py::module_& m, std::string const& name)


I would move bind_ParameterStudy into a generic binding function (like bind_CoompartmentalModel), that returns the binding object. And then move the model specific definitions of run[...] functions into the model namespace. So you could call '.def(...)' on the return of bind_ParameterStudy.

But I keep the graph parameter and sim types for now, right?

MaxBetzDLR · 2025-11-13T14:58:56Z

pycode/memilio-simulation/memilio/simulation/bindings/models/osecir.cpp

+    pymio::bind_class<StudyT, pymio::EnablePickling::Never>(m, name.c_str())
+        .def(py::init<const ParametersT&, double, double, double, size_t>(), py::arg("parameters"), py::arg("t0"),
+             py::arg("tmax"), py::arg("dt"), py::arg("num_runs"))
+        .def_property_readonly("num_runs", &StudyT::get_num_runs)


Add py::arg() and strings as documentation. Documentation especially for the functions that should be called by the user.

MaxBetzDLR · 2025-11-13T15:01:14Z

pycode/memilio-simulation/memilio/simulation/bindings/models/osecir.cpp

-             [](mio::ParameterStudy<double, Simulation>& self) { //default argument doesn't seem to work with functions
-                 return self.run([](auto&& g) {
-                     return draw_sample(g);
+             [&create_simulation](StudyT& self) { //default argument doesn't seem to work with functions


What is this comment of default arguments about?

I think it references the fact that the cpp run function (now run_serial) has a default value for one of its arguments, that is a function type.

reneSchm and others added 5 commits September 3, 2025 15:16

first working example

a871ba6

typename FPMerge branch 'main' into abm-parameter-study

f65c9b2

[wip] parameter studies v2

7f69da2

[wip] add run_idx to create_sim function

eaaa5c2

mpi wokrks

280afa5

reneSchm self-assigned this Oct 14, 2025

reneSchm added loc::backend This issue concerns the C++ backend implementation. model::abm This issue concerns any kind of agent-based model. class::improvement Cleanup that doesn't affect functionality class::performance Performance related issues labels Oct 14, 2025

reneSchm linked an issue Oct 14, 2025 that may be closed by this pull request

Create parameter study for ABM #468

Open

reneSchm changed the title ~~Abm parameter study~~ 468 Abm parameter study Oct 14, 2025

reneSchm added 6 commits October 16, 2025 16:19

use ParameterStudy2 in ode_secir examples

f52035d

Merge branch 'abm-parameter-study' of github.com:SciCompMod/memilio i…

6df3ab5

…nto abm-parameter-study

[wip] remove old ParameterStudies from cpp

47088f7

Merge branch 'main' into abm-parameter-study

703e03a

Fix up ode_secir_read_graph

2646042

patch python bindings to mostly emulate old ParameterStudy behaviour

9b593f5

reneSchm marked this pull request as ready for review October 22, 2025 09:29

reneSchm added 2 commits October 22, 2025 11:46

explicit type conversion

df4f000

another explicit type conversion

2d278c0

reneSchm added 8 commits October 22, 2025 14:15

improve coverage

5fa14f4

move abm study, restore minimal abm

c6e292a

clean up examples, improve mpi handling

3af580c

add hdf5 dep to abm study example

4371622

improve non-PS coverage

fe9ef05

remove developement artifacts

63b7a6d

small cleanup, add test

9bae572

Merge branch 'main' into abm-parameter-study

9e1de1e

reneSchm requested review from MaxBetzDLR, annawendler and xsaschako October 27, 2025 13:47

reneSchm and others added 4 commits October 28, 2025 10:35

change name back to ParameterStudy

651f1ba

update parameters to run

ea3acde

Revert "update parameters to run"

f23f5ff

This reverts commit ea3acde.

update rng log message

6b21559

annawendler reviewed Nov 6, 2025

View reviewed changes

reneSchm and others added 4 commits November 6, 2025 16:16

[ci skip] Apply suggestions from code review

7dc86ac

Co-authored-by: annawendler <106674756+annawendler@users.noreply.github.com>

remove out of scope index ctor

3db2bcd

fix comment

67dfb49

Apply suggestions from code review

5c03d29

Co-authored-by: annawendler <106674756+annawendler@users.noreply.github.com>

reneSchm requested a review from annawendler November 7, 2025 08:49

annawendler reviewed Nov 7, 2025

View reviewed changes

cpp/examples/abm_parameter_study.cpp Outdated Show resolved Hide resolved

cpp/examples/abm_parameter_study.cpp Outdated Show resolved Hide resolved

cpp/memilio/compartments/parameter_studies.h Outdated Show resolved Hide resolved

reneSchm added 2 commits November 7, 2025 18:43

[ci skip] clarify comment on abm study creation

665f8c4

[ci skip] review suggestion

35fb3a1

annawendler reviewed Nov 10, 2025

View reviewed changes

cpp/memilio/compartments/parameter_studies.h Outdated Show resolved Hide resolved

cpp/memilio/compartments/parameter_studies.h Outdated Show resolved Hide resolved

[ci skip] update parameter study class description

7819b98

annawendler approved these changes Nov 10, 2025

View reviewed changes

mknaranja changed the title ~~468 Abm parameter study~~ 468 ABM parameter study Nov 13, 2025

MaxBetzDLR requested changes Nov 13, 2025

View reviewed changes

468 ABM parameter study #1395

Are you sure you want to change the base?

468 ABM parameter study #1395

Conversation

reneSchm commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes and Information

Merge Request - Guideline Checklist

Checks by code author

Checks by code reviewer(s)

Uh oh!

codecov bot commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaxBetzDLR left a comment

Choose a reason for hiding this comment

Uh oh!

MaxBetzDLR Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

reneSchm Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

MaxBetzDLR Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

MaxBetzDLR Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

reneSchm Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

reneSchm commented Oct 14, 2025 •

edited

Loading

codecov bot commented Oct 22, 2025 •

edited

Loading