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.4.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: foragax-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 7ef4d117ee69955630e3d622636041924b96c0fbd8bdeb989738ac810b560b7f
MD5 c54edb934e1a7ece08bab21575648494
BLAKE2b-256 694b6ffb1b23f938532d07638d74a00da159a18a9306408af2fdd0a4ab62cb36

See more details on using hashes here.

File details

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

File metadata

  • Download URL: foragax-0.0.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 876f34e81e01dea42fcbc1b847b533749fd06b45410711794c42368da518cae0
MD5 01aab1f79add386c6474806d28eb8fcf
BLAKE2b-256 955453aad7103f7f2fd61730040fd479ca450ad5b1b348871ae1f37a5eb277b2

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