User Guide
API Reference
Simulator
Simulator.generate_scenarios()
Simulator.run_model()
Simulator.setup()
Simulator.run()
Simulator.run_visual()
Simulator.run_parallel()
Simulator.run_parallel_multithread()
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.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.setup()
Environment.to_dict()
Agent
Agent.setup()
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()
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
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
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.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.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
Melodie is created by Songmin Yu and Zhanyi Hou under MIT License.