APIs#

One page per domain package of modelly: core, space (with space.geo and space.networks), time, data, behaviour, scenarios, experiments, batch, viz, timetravel, llm and zoo, plus the log, migrate, lint, profile, provenance and plugins modules. scenarios, experiments, calibrate, sensitivity, batch and viz, plus the log, migrate, lint and profile modules. scenarios, batch, viz, timetravel and studio, plus the log, migrate, lint and profile modules.

Core
- Model
  - Model
- Agent
  - Agent
- Agent sets
- Columns
- Random numbers
  - PyFastRandom
  - FastRandom
- Checkpoints
- Exceptions
Space
- Cells
  - Cell
  - CellCollection
- Cell agents
- Discrete spaces
- Integer cells: index, occupancy and row-placed agents
- Continuous space
Geospatial space
- GeoSpace
- Rasters
  - RasterLayer
- Road networks
  - RoadNetwork
  - download_osm()
- Synthetic populations
  - ipf()
  - synthesize_population()
- Export
Networks
- Temporal networks
  - TemporalEdge
  - TemporalNetwork
- Multilayer networks
  - MultilayerNetwork
- Contact matrices
  - age_groups()
  - contact_matrix()
- Network statistics
- Import and export
Time
- Events
- Scheduling on the model
  - HasSchedule
- Signals
Data
- DataCollector
  - DataCollector
- Arrow, Parquet and DuckDB
- Reporters
- Datasets
- Recorders
Behaviour
- Actions
- States
- Meta-agents
Scenarios
- Scenario
  - Scenario
- Running scenarios
- Storing results
- Exceptions
Experiments
- Experiment
- Parameter space
- Designs
- Results store
- Runs
- Executors
- Experiment files and the worker
Calibration
- Methods
- Priors, targets and distances
- Posterior
- Runs
- Calibration files
  - priors_and_fixed()
  - load_calibration()
Sensitivity
- Methods
- Studies and results
- Analysis files
  - load_sensitivity()
Batch
- Parallel runs
- Cohorts
  - CohortTable
  - from_counts()
Viz
- Solara app
- User parameters
  - UserParam
  - Slider
- Matplotlib-based visualizations
- Altair-based visualizations
- Command console
- Portrayal components
- Backends
- Space renderer
  - SpaceRenderer
- Space drawers
- Publication styles and palettes
- Headless figures and animations
Time travel
- Timeline
- thaw()
- reseed_model()
- Recorder
- MemoryRing
  - MemoryRing.get()
  - MemoryRing.discard()
- DiskRing
- data_difference()
- state_difference()
- diff()
- Difference
- RunDiff
- agent_state()
- ModelState
- model_state()
- same()
- first_value_difference()
- first_state_difference()
Studio
- StudioConfig
  - StudioConfig.memory_budget
  - StudioConfig.source_file
  - StudioConfig.to_json()
  - StudioConfig.from_json()
  - StudioConfig.export()
  - StudioConfig.from_environment()
- Parameter
  - Parameter.editable
- kind_of()
- parameters_of()
- import_source()
- load_model_class()
- load_portrayal()
- module_name()
- StudioSession
  - StudioSession.shown
  - StudioSession.replaying
  - StudioSession.say()
  - StudioSession.reset()
  - StudioSession.step()
  - StudioSession.scrub()
  - StudioSession.replay()
  - StudioSession.profile_report()
  - StudioSession.source_file()
  - StudioSession.lint()
- ReplayTimeline
  - ReplayTimeline.steps
  - ReplayTimeline.span
  - ReplayTimeline.at()
  - ReplayTimeline.stop()
- track()
- model_series()
- series_figure()
- agent_classes()
- agent_table()
- figure_bytes()
- series_image()
- space_image()
- parquet_available()
- data_bytes()
- checkpoint_file()
- timeline_steps()
- replay_frames()
- animation_bytes()
- new_session()
logging
- function_logger()
- get_module_logger()
- get_rootlogger()
- log_to_stderr()
- method_logger()
Migrate
- Finding
- FileResult
  - FileResult.changed
- map_module()
- rewrite_line()
- find_flags()
- migrate_source()
- python_files()
- render_diff()
- render_report()
- migrate()
- build_parser()
- main()
Lint
- Finding
  - Finding.location()
- Rule
- lint_paths()
- lint_source()
- Rule
- dotted()
- is_population()
- is_set_expr()
- is_mutable_literal()
- calls_super_init()
- branches()
- ConfigError
- prefixes()
- matches()
- Config
  - Config.keeps()
  - Config.file_ignores()
- find_pyproject()
- load_config()
Profile
- Profiler
- SizeComparison
- StepRecord
  - StepRecord.add()
- compare_sizes()
- StepRecord
  - StepRecord.add()
- agent_classes()
- callable_name()
- Profiler
Provenance
- ManifestError
- json_safe()
- manifest_path()
- check_format()
- read_manifest()
- write_manifest()
- RunSpec
- read_scenario()
- run_study()
- Verification
  - Verification.matches
- verify()
- Difference
- Tolerance
- first_difference()
- BundleError
- bundle_entries()
- bundle()
- odd_markdown()
LLM
- Client and agents
- Requests and replies
- Cache
  - ResponseCache
- Budgets and retries
- Providers
- Schemas
  - validate()
  - parse_json()
- Errors
Plugins
- PluginError
- Plugin
  - Plugin.load()
- discover()
- load_all()
Model zoo
- Catalogue and copying
- Epidemiology
- Ecology
- Economics
- Sociology and political science
- Transport and energy