Melodie Logo
  • Installation
    • User Installation
    • Developer Installation
    • Dependency Note
  • Introduction
    • Agent-based Model (ABM)
    • Melodie Framework
      • Model
      • Scenario
      • Modelling Manager
      • Infrastructure
  • Tutorial
    • Project Structure
    • Agent
    • Scenario
      • Generate agent_params
      • Load simulator_scenarios
    • Model
    • Environment
    • DataCollector
    • Last Words
  • Framework Comparison
    • Project Structure
    • Model Components
      • Melodie
      • Mesa
      • AgentPy
      • Summary
    • Scenario Management
      • Melodie
      • Mesa
      • AgentPy
      • Summary
    • Modeling Manager
      • Calibrator
      • Trainer
  • Model Gallery
    • CovidGridContagion
      • Project Structure
      • Grid and Spot
      • Matrix Data
      • Model
      • GridAgent
    • CovidNetworkContagion
      • Project Structure
      • Model
      • Scenario
    • CovidContagionCalibrator
      • Project Structure
      • Calibrator
      • Algorithm
      • Results
    • RockPaperScissorsTrainer
      • Model Setup
      • Trainer
      • Results
    • CovidContagionVisual
      • Visualizer
      • MelodieStudio
      • How to start?
  • Advanced Topics
    • TroubleShooting
      • Port Already in use
        • Windows
        • MacOS, Linux or other *nix systems
    • Melodie Errors
    • Data Types
      • Notice
  • API Reference
    • Model
      • ModelRunRoutine
      • 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()
    • Agent
      • Agent
        • Agent.id
        • Agent.scenario
        • Agent.model
        • Agent.setup()
    • AgentList
      • BaseAgentContainer
        • BaseAgentContainer.new_id()
        • BaseAgentContainer.all_agent_ids()
        • BaseAgentContainer.to_list()
      • AgentList
        • AgentList.agents
        • 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()
    • Environment
      • Environment
        • Environment.scenario
        • Environment.model
        • Environment.setup()
        • Environment.to_dict()
    • DataCollector
      • DataCollector
        • DataCollector.setup()
        • DataCollector.time_elapsed()
        • DataCollector.add_agent_property()
        • DataCollector.add_environment_property()
        • DataCollector.env_property_names()
        • DataCollector.agent_property_names()
        • DataCollector.agent_containers()
        • DataCollector.collect_agent_properties()
        • DataCollector.append_agent_properties_by_records()
        • DataCollector.append_environment_properties()
        • DataCollector.status
        • DataCollector.collect()
        • DataCollector.db
        • DataCollector.calc_time()
        • DataCollector.get_single_agent_data()
        • DataCollector.save()
    • Grid
      • GridItem
        • GridItem.grid
        • GridItem.x
        • GridItem.y
      • GridAgent
        • GridAgent.category
        • GridAgent.set_category()
        • GridAgent.rand_move_agent()
      • Spot
        • Spot.get_spot_agents()
      • Grid
        • Grid.setup_params()
        • Grid.setup()
        • Grid.add_category()
        • Grid.get_spot()
        • Grid.get_agent_ids()
        • Grid.coords_wrap()
        • 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.setup_agent_locations()
        • Grid.set_spot_property()
        • Grid.rand_move_agent()
    • Network
      • NetworkAgent
        • NetworkAgent.category
        • NetworkAgent.set_category()
      • Edge
        • Edge.setup()
        • Edge.post_setup()
      • 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()
    • DataInfo
      • DataFrameInfo
        • DataFrameInfo
      • MatrixInfo
        • MatrixInfo
    • DataLoader
      • DataLoader
        • DataLoader.register_dataframe()
        • DataLoader.clear_cache()
        • DataLoader.load_dataframe()
        • DataLoader.load_matrix()
        • DataLoader.dataframe_generator()
        • DataLoader.generate_scenarios_from_dataframe()
        • DataLoader.generate_scenarios()
    • Scenario
      • Scenario
        • Scenario.copy()
        • Scenario.setup()
        • Scenario.to_dict()
        • Scenario.to_json()
        • Scenario.get_dataframe()
        • Scenario.get_matrix()
    • Simulator
      • BaseModellingManager
        • BaseModellingManager.get_dataframe()
        • BaseModellingManager.get_matrix()
        • BaseModellingManager.subworker_prerun()
        • BaseModellingManager.pre_run()
        • BaseModellingManager.generate_scenarios()
      • SimulatorMeta
        • SimulatorMeta.to_dict()
      • Simulator
        • Simulator.generate_scenarios()
        • Simulator.run_model()
        • Simulator.setup()
        • Simulator.run()
        • Simulator.run_visual()
        • Simulator.run_parallel()
        • Simulator.new_parallel()
    • 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()
    • DB
      • DBConn
        • DBConn.table_dtypes
        • DBConn.existing_connections
        • DBConn.SCENARIO_TABLE
        • DBConn.ENVIRONMENT_RESULT_TABLE
        • DBConn.from_connection_string()
        • DBConn.get_engine()
        • DBConn.create_connection()
        • DBConn.create_from_existing_db()
        • DBConn.register_dtypes()
        • DBConn.get_table_dtypes()
        • DBConn.close()
        • DBConn.clear_database()
        • DBConn.write_dataframe()
        • DBConn.read_dataframe()
        • DBConn.drop_table()
        • DBConn.query()
      • create_db_conn()
      • get_sqlite_filename()
    • Melodie Exceptions
      • assert_exc_occurs()
      • assert_exc_type_occurs()
      • MelodieException
      • MelodieExceptions
        • MelodieExceptions.Assertions
        • MelodieExceptions.General
        • MelodieExceptions.Program
        • MelodieExceptions.State
        • MelodieExceptions.Scenario
        • MelodieExceptions.Agents
        • MelodieExceptions.Environment
        • MelodieExceptions.Data
        • MelodieExceptions.Tools
        • MelodieExceptions.Visualizer
  • Change Log
    • Major Version 0.x
      • v0.8.0 (May. 10, 2023)
      • v0.7.0 (Mar. 25, 2023)
      • v0.6.0 (Jan. 04, 2023)
      • v0.5.0 (Dec. 17, 2022)
      • v0.4.2 (Dec. 15, 2022)
      • v0.4.1 (Dec. 12, 2022)
      • v0.4.0 (Nov. 15, 2022)
      • v0.3.0 (Oct. 28, 2022)
      • v0.2.0 (Oct. 24, 2022)
      • v0.1.1 (Aug. 23, 2022)
      • v0.1.0 (Jul. 22, 2022)
      • Start (May. 10, 2021)
  • Contribution
    • Report Bugs
      • Report Melodie Bugs
      • Report Documentation Bugs
    • Ask for Functionalities
    • How to Contribute
  • About
Melodie
  • Search

© Copyright 2021-2022, ABM4ALL.

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