What's new

All notable changes to the codebase are documented in this file.

Version 1.4.9 (2026-02-24)

Add default_build_fn for calibration: routes parameters by prefix (hiv_*, syph_*, nw_*) to diseases and networks automatically, removing need for custom build_fn
sti.Calibration now uses default_build_fn when no build_fn is provided
Fix make_df() time column to use years from timevec instead of integer index
Fix parse_study() to guard sim_results reordering when save_results=False
Fix calibration data column names to use dot notation (hiv.prevalence)
Standardize import conventions: import stisim as sti, import hivsim (no alias)

Add hivsim_examples package with simple and zimbabwe pre-configured examples
Add hs.demo() function for quickly running example HIV simulations (e.g. hs.demo('zimbabwe'))
Add Sim.plot() override that auto-selects curated HIV result keys when HIV is present
Add data parameter to sti.Sim for passing comparison data (e.g. UNAIDS estimates) to starsim's plot overlay
Fix process_demographics() to use total_pop from sim_pars when set, and correctly scale age data (values in thousands)
Fix separate_pars() so kwargs override sim_pars defaults (e.g. stop=1995 overrides sim_pars=dict(stop=2025))
Fix get_age_distribution() to handle CSV files without a year column

Fix bugs in coinfection analyzer: age limit typo, variable name errors for male results
Remove STIsim Pregnancy module, now superseded by the Starsim Pregnancy module
Add exposed/incubation period for syphilis (dur_exposed), and allow maternal transmission during this stage
Rename syphilis birth outcome key active to mat_active to reflect inclusion of exposed stage
Add .vscode/ and *.code-workspace to .gitignore

Add sensible beta_m2f defaults for all diseases (NG: 0.06, CT: 0.06, TV: 0.1, HIV: 0.05, syphilis: 0.1)
Add rel_trans_hiv_ng parameter to the HIV-NG connector
Fix connector handling in Sim.init() when a single connector is passed
Set auto_plot=False on subpopulation, care-seeking, and detail results so sim.plot() shows only high-level results
Add tutorials: intro (gonorrhea), co-transmission, results/plotting, and interventions
Add user guide pages for interventions (testing, treatment, ART, VMMC, PrEP)
Update disease docs with beta_m2f defaults and per-act description
Pre-build font cache in docs CI workflow

Fixes to the pair-matching algorithm within the sexual network to better align partner ages
Improvements to networks, including analyzers for debut age and partner age differences
GitHub info: PR 143

Improvements to networks, including analyzers for relationship duration and network degree
Adds a PriorPartners network for recalling past relationships - for use in partner notification
GitHub info: PR 135

Bugfixes to calibration class and BV connector
Replaces the match_pairs method of the StructuredSexual network with the faster option that was previously in the FastStructuredSexual network (now removed).
GitHub info: PR 124

Improvements to the Calibration class: this class now inherits directly from the Starsim calibration class, so users will have access to easier parameter constraints, plotting, flexible fit functions, etc
Generalization of the coinfection class to handle any two diseases
Addition of a more detailed BV model
GitHub info: PR 119

Initial version of STIsim with structured sexual networks, models of HIV and syphilis, worksflows for model calibration, and interventions for testing and treatment.
GitHub info: PR 22