Metadata-Version: 2.4
Name: rbmpy
Version: 0.0.3
Summary: Python tools for the Reduced Bayesian Model (RBM): simulation, fitting, and analysis.
Author-email: Rasmus Bruckner <rasmus.bruckner@uni-hamburg.de>
License: 
        The MIT License (MIT)
        
        Copyright (c) 2025 Rasmus Bruckner
        
        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: Source, https://github.com/rasmusbruckner/rbmpy
Project-URL: Documentation, https://rasmusbruckner.github.io/rbmpy/
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: seaborn
Requires-Dist: allinpy
Requires-Dist: pycircstat2
Dynamic: license-file

# rbmpy

Python tools for the Reduced Bayesian Model (RBM), including simulation, parameter estimation, regression, and task modeling.

## Installation

Install the package from PyPI with:

```bash
pip install rbmpy
```

## Documentation

See the package website for detailed [documentation](https://rasmusbruckner.github.io/rbmpy/).

## `agent_rbm`

Contains the `AlAgent` and `AgentVars` classes, providing a Python implementation of the RBM for simulation and parameter estimation.

## `circular_regression`

Contains custom regression models (currently circular) that can be combined with the RBM.

## `task`

Contains the `ChangePointTask` class for change-point task simulations. The agent and regression models can be applied to these task data.

## Questions?

For questions, please get in touch with me: [rasmus.bruckner@uni-hamburg.de](mailto:rasmus.bruckner@uni-hamburg.de).

## Built With

* [Python](https://www.python.org)
* [allinpy](https://github.com/rasmusbruckner/allinpy)

## Author

* **Rasmus Bruckner** - [GitHub](https://github.com/rasmusbruckner)

## Acknowledgments

[Matt Nassar](https://sites.brown.edu/mattlab/) and
[Hashim Satti](https://www.ewi-psy.fu-berlin.de/en/psychologie/arbeitsbereiche/neural_dyn_of_vis_cog/learning-lab/team/satti/index.html)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Changelog

See the [CHANGELOG](CHANGELOG.md) for details on recent changes, updates, and releases.
