Melodie Logo

User Guide

  • Installation
    • User Installation
    • Developer Installation
    • Dependency Note
  • Introduction
    • Agent-based Model (ABM)
    • Melodie Framework
      • The Model
      • The Scenario
      • Modelling Manager
      • Infrastructure
  • Tutorial
    • Model
    • Scenario Definition
    • Environment Logic
    • Agent Behavior
    • Data Collection Setup
    • Run the model
    • Parallel Execution
  • Framework Comparison
    • Project Structure
    • High-Level Comparison
    • A Note on This Comparison
    • Advanced Features in Melodie
  • Model Gallery
    • CovidContagionGrid
      • Grid: Project Structure
      • Grid: Key Changes
      • Grid: Input Data
      • Grid: Running the Model
      • Grid: Code
        • Model Structure
        • Environment Logic
        • Agent Behavior
        • Data Collection Setup
        • Grid and Spot Definition
    • CovidContagionGridVisual
      • Visualizer: Project Structure
      • Visualizer: Key Changes
      • Visualizer: Running the Model
      • Visualizer: Customization Guide
      • Visualizer: Code
        • Visualizer Definition
        • Model Structure
        • Environment Logic
        • Agent Behavior
        • Grid Definition
    • CovidContagionNetwork
      • Network: Project Structure
      • Network: Key Changes
      • Network: Input Data
      • Network: Running the Model
      • Network: Code
        • Model Structure
        • Environment Logic
        • Agent Behavior
        • Scenario Definition
        • Data Collection Setup
    • CovidContagionCalibrator
      • Calibrator: Project Structure
      • Calibrator: Key Changes
      • Calibrator: GA Concepts
      • Calibrator: Input Data
      • Calibrator: Running the Model
      • Calibrator: Code
        • Calibrator Definition
        • Scenario Definition
        • Model Structure
        • Environment Logic
        • Agent Behavior
        • Data Collection Setup
    • RockPaperScissorsTrainer
      • Trainer: Project Structure
      • Trainer: GA Concepts
      • Trainer: How It Works
      • Trainer: Results
      • Trainer: Running the Model
      • Trainer: Code
        • Model Structure
        • Environment Logic
        • Agent Behavior
        • Data Collection Setup
        • Scenario Definition
        • Trainer Definition

API Reference

  • API Reference
    • Simulator
      • Simulator
        • Simulator.generate_scenarios()
        • Simulator.run_model()
        • Simulator.setup()
        • Simulator.run()
        • Simulator.run_visual()
        • Simulator.run_parallel()
        • Simulator.run_parallel_multithread()
    • Model
      • Model
        • Model.create()
        • Model.setup()
        • Model.create_db_conn()
        • Model.create_agent_list()
        • Model.create_environment()
        • Model.create_grid()
        • Model.create_network()
        • Model.create_data_collector()
        • Model.create_agent_container()
        • Model.run()
        • Model.iterator()
        • Model.init_visualize()
    • Scenario
      • Scenario
        • Scenario.copy()
        • Scenario.load_data()
        • Scenario.setup_data()
        • Scenario.initialize()
        • Scenario.setup()
        • Scenario.load_dataframe()
        • Scenario.load_matrix()
        • Scenario.to_dict()
        • Scenario.to_json()
        • Scenario.get_dataframe()
        • Scenario.get_matrix()
    • Environment
      • Environment
        • Environment.setup()
        • Environment.to_dict()
    • Agent
      • Agent
        • Agent.setup()
    • Agent List
      • AgentList
        • AgentList.setup_agents()
        • AgentList.setup()
        • AgentList.init_agents()
        • AgentList.random_sample()
        • AgentList.filter()
        • AgentList.add()
        • AgentList.to_list()
        • AgentList.to_dataframe()
        • AgentList.set_properties()
        • AgentList.get_agent()
        • AgentList.method_foreach()
        • AgentList.vectorize()
        • AgentList.remove()
    • Data Collector
      • DataCollector
        • DataCollector.setup()
        • DataCollector.time_elapsed()
        • DataCollector.add_agent_property()
        • DataCollector.add_environment_property()
        • DataCollector.add_custom_collector()
        • DataCollector.env_property_names()
        • DataCollector.agent_property_names()
        • DataCollector.agent_containers()
        • DataCollector.collect_agent_properties()
        • DataCollector.collect_custom_properties()
        • DataCollector.collect_single_custom_property()
        • DataCollector.append_agent_properties_by_records()
        • DataCollector.append_environment_properties()
        • DataCollector.status
        • DataCollector.collect()
        • DataCollector.calc_time()
        • DataCollector.get_single_agent_data()
        • DataCollector.save()
        • DataCollector.save_dataframe()
    • Grid & Spot
      • Grid
        • Grid.init_grid()
        • Grid.setup_params()
        • Grid.setup()
        • Grid.add_category()
        • Grid.get_spot()
        • Grid.get_agent_ids()
        • Grid.coords_wrap()
        • Grid.get_agent_neighborhood()
        • Grid.get_spot_neighborhood()
        • Grid.add_agent()
        • Grid.remove_agent()
        • Grid.move_agent()
        • Grid.get_agent_pos()
        • Grid.height()
        • Grid.width()
        • Grid.get_neighbors()
        • Grid.get_spot_agents()
        • Grid.get_colormap()
        • Grid.spots_to_json()
        • Grid.get_empty_spots()
        • Grid.find_empty_spot()
        • Grid.setup_agent_locations()
        • Grid.set_spot_property()
        • Grid.rand_move_agent()
        • Grid.get_agent_container()
        • Grid.agent_categories
      • Spot
        • Spot.get_spot_agents()
        • Spot.get_style()
    • Network & Edge
      • Network
        • Network.setup()
        • Network.add_edge()
        • Network.get_edge()
        • Network.remove_edge()
        • Network.get_neighbors()
        • Network.remove_agent()
        • Network.add_agent()
        • Network.create_edge()
        • Network.all_agents()
        • Network.get_node_edges()
        • Network.setup_layout_creator()
        • Network.update_layout()
        • Network.get_position()
        • Network.setup_agent_connections()
      • Edge
        • Edge.setup()
        • Edge.post_setup()
    • Calibrator
      • Calibrator
        • Calibrator.setup()
        • Calibrator.collect_data()
        • Calibrator.generate_scenarios()
        • Calibrator.get_params_scenarios()
        • Calibrator.run()
        • Calibrator.run_once_new()
        • Calibrator.target_function()
        • Calibrator.distance()
        • Calibrator.add_scenario_calibrating_property()
        • Calibrator.add_environment_property()
    • Trainer
      • Trainer
        • Trainer.add_agent_training_property()
        • Trainer.setup()
        • Trainer.get_trainer_scenario_cls()
        • Trainer.collect_data()
        • Trainer.run()
        • Trainer.run_once_new()
        • Trainer.utility()
        • Trainer.target_function()
        • Trainer.add_agent_property()
        • Trainer.add_environment_property()
        • Trainer.generate_scenarios()
        • Trainer.generate_trainer_params_list()

Development

  • Contribution
    • Reporting Issues
    • Contributing Code
    • Adding to the Model Gallery
  • Change Log
    • Major Version 0.x
      • Version 1.1.0 (Dec. 10, 2025)
      • Version 1.0.0 (Mar. 14, 2024)
      • Version 0.8.0 (May. 10, 2023)
      • Version 0.7.0 (Mar. 25, 2023)
      • Version 0.6.0 (Jan. 04, 2023)
      • Version 0.5.0 (Dec. 17, 2022)
      • Version 0.4.2 (Dec. 15, 2022)
      • Version 0.4.1 (Dec. 12, 2022)
      • Version 0.4.0 (Nov. 15, 2022)
      • Version 0.3.0 (Oct. 28, 2022)
      • Version 0.2.0 (Oct. 24, 2022)
      • Version 0.1.1 (Aug. 23, 2022)
      • Version 0.1.0 (Jul. 22, 2022)
      • Project Start (May. 10, 2021)
  • About
Melodie
  • API Reference
  • View page source

API Reference

  • Simulator
    • Simulator
  • Model
    • Model
  • Scenario
    • Scenario
  • Environment
    • Environment
  • Agent
    • Agent
  • Agent List
    • AgentList
  • Data Collector
    • DataCollector
  • Grid & Spot
    • Grid
    • Spot
  • Network & Edge
    • Network
    • Edge
  • Calibrator
    • Calibrator
  • Trainer
    • Trainer
Previous Next

© Copyright 2021-2025, ABM4ALL.

Built with Sphinx using a theme provided by Read the Docs.