Metadata-Version: 2.4
Name: gabse
Version: 0.1.5
Summary: The GABSE (Generic Agent-Based Simulation for Engineering) framework
Author: Carl Toller Melén
Author-email: Carl Toller Melén <carl@tollermelen.se>
Maintainer-email: Carl Toller Melén <carl@tollermelen.se>
License: MIT License
        
        Copyright (c) 2025 Carl Toller Melén
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/tm-carl/GABSE
Project-URL: Repository, https://github.com/tm-carl/GABSE
Project-URL: Issues, https://github.com/tm-carl/GABSE/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.3.4
Requires-Dist: scipy>=1.16.3
Requires-Dist: sortedcontainers>=2.4.0
Dynamic: license-file

# GABSE
This is the GABSE (Generic Agent-Based Simulation for Engineering) framework.  It provides classes and methods for creating and managing simulations involving agents, their actions, sensors, and the simulation context. It is based on an agent-based modeling technique and is developed with the intention of being lightweight, scalable, and flexible. This package provides the engine, action scheduling, generic agent functionality, and tools for sensory data collection and management.

## Installation
GABSE can be installed from PyPi using pip.

Installation:
```
pip install gabse
```

Update:
```
pip install gabse --upgrade
```

Uninstall:
```
pip uninstall gabse
```

You can find the GABSE at both PyPi and TestPyPi using these links:

```
https://pypi.org/project/gabse/
https://test.pypi.org/project/gabse/
```

### Dependencies
GABSE has the following dependencies
- sortedcontainers
- numpy
- scipy

## Funactionality
Loreum ipsum.

## EXAMPLES
These are some example simulations that can be used for testing and learning how the GABSE framework functions.
- Zombie apocalypse (both 2D and 3D)

## About
This simulation framework was developed based on PhD research conducted at the Department of Mechanical Engineering, Blekinge Institute of Technology.
