Skip to main content

ABM package in JAX.

Project description

Foragax is an Agent Based Modelling (ABM) package based on JAX. It provides scalable and efficient ABM simulations by leveraging JAX's automatic vectorization and just-in-time compilation capabilities. The main features of Foragax include:

  • Agent manipulation (adding, removing, updating, selecting, and sorting agents) with just-in-time compilation.
  • Vectorized ray-casting and wall-detection for simulating agents moving in a continuous 2D environment with custom boundaries and obstacles.
  • Tutorials and examples to help users get started with ABM using JAX.
  • Familiar ABM interface for creating and manipulating agents.

Installation

pip install foragax

Requires Python 3.10+, JAX 0.4.13+, and flax 0.7.4+

Citation

If this framework was useful in your work, please consider starring and cite: (arXiv link)

@misc{chaturvedi2024foragaxagentbasedmodelling,
      title={Foragax: An Agent Based Modelling framework based on JAX}, 
      author={Siddharth Chaturvedi and Ahmed El-Gazzar and Marcel van Gerven},
      year={2024},
      eprint={2409.06345},
      archivePrefix={arXiv},
      primaryClass={cs.MA},
      url={https://arxiv.org/abs/2409.06345}, 
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foragax-0.0.3.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

foragax-0.0.3-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file foragax-0.0.3.tar.gz.

File metadata

  • Download URL: foragax-0.0.3.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.10

File hashes

Hashes for foragax-0.0.3.tar.gz
Algorithm Hash digest
SHA256 865b59def03d6dee0656a7606b553b759e1c23d5a9f3d8598107fd1c8db4d0f2
MD5 2c8f4069b134ceb27940fb6efc7d01ac
BLAKE2b-256 5643420df46080a3d3c1384a8720427ab16ab97d8f6fb039d04b9949f86c915f

See more details on using hashes here.

File details

Details for the file foragax-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: foragax-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.10

File hashes

Hashes for foragax-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9051e92b73562ac9de2f3c8c83d67067310cc799a9d238bc24c3a8580d502c5a
MD5 a33ab6598f25e434e5f58b0b39662049
BLAKE2b-256 e623ed67e6f3893e15d2e5b5d308c10b76ab9fd05869b11d5ff2a06d811c963b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page