PythonABM documentation

PythonABM makes complex agent-based modeling (ABM) simulations in Python accessible by providing an efficient base framework for constructing ABMs. More information on PythonABM can be found below.

• GitHub: github.com/kemplab/pythonabm

• PyPI: pypi.org/project/pythonabm

Documentation

• Installation
  • CUDA Support
• Example simulation
  • Simulation script
  • Template file
• Running a simulation

Structure

• Simulation
  • Simulation
    • Simulation.add_agents()
    • Simulation.agent_array()
    • Simulation.agent_graph()
    • Simulation.assign_bins()
    • Simulation.create_video()
    • Simulation.data()
    • Simulation.end()
    • Simulation.full_setup()
    • Simulation.get_neighbors()
    • Simulation.indicate_arrays()
    • Simulation.indicate_graphs()
    • Simulation.info()
    • Simulation.make()
    • Simulation.mark_to_hatch()
    • Simulation.mark_to_remove()
    • Simulation.random_vector()
    • Simulation.run_simulation()
    • Simulation.set_paths()
    • Simulation.setup()
    • Simulation.simulation_mode_0()
    • Simulation.simulation_mode_1()
    • Simulation.simulation_mode_2()
    • Simulation.simulation_mode_3()
    • Simulation.start()
    • Simulation.step()
    • Simulation.step_image()
    • Simulation.step_image_3d()
    • Simulation.step_values()
    • Simulation.temp()
    • Simulation.update_populations()
    • Simulation.yaml_parameters()
• Backend
  • get_neighbors_gpu()
  • cuda_magnitude()
  • Graph
    • Graph.num_neighbors()
  • assign_bins_jit()
  • check_direct()
  • check_existing()
  • check_output_dir()
  • commandline_param()
  • empty_array()
  • get_end_step()
  • get_neighbors_cpu()
  • normal_vector()
  • progress_bar()
  • record_time()
  • starting_params()
  • template_params()