https://github.com/timkam/quantitative-bipolar-argumentation
This is a CPython implementation for Explaining Change in Quantitative Bipolar Argumentation (Kampik, Čyras, Ruiz Alarcón, 2024).
https://github.com/timkam/quantitative-bipolar-argumentation
Last synced: 8 months ago
JSON representation
This is a CPython implementation for Explaining Change in Quantitative Bipolar Argumentation (Kampik, Čyras, Ruiz Alarcón, 2024).
- Host: GitHub
- URL: https://github.com/timkam/quantitative-bipolar-argumentation
- Owner: TimKam
- License: gpl-2.0
- Created: 2022-10-31T14:21:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-09-03T13:59:00.000Z (9 months ago)
- Last Synced: 2025-09-03T15:32:34.659Z (9 months ago)
- Language: Jupyter Notebook
- Homepage:
- Size: 4.61 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QBAF-Py
This project provides _QBAF-Py_, a library for drawing inferences from Quantitative Bipolar Argumentation Frameworks (QBAFs) and explaining them.
The library core is written in CPython (C with a Python API) to facilitate speed and efficiency.
## Requirements & Installation
Installing *QBAF-Py* requires [pip](https://pypi.org/project/pip/).
To install *QBAF-Py*, run in the project's root directory:
```
pip install .
```
Note: To install on Windows, Microsoft Visual C++ 14.0 or greater might be required.
_QBAF-Py_ features an optional basic visualization module for QBAFs and some explanation types.
Install it with `pip install -e .[Visualizer]` and note that it is required for running the examples provided in the [Jupyter notebook](examples.ipynb).
## Dependencies
*QBAF-Py* does not have any dependencies!
Only if you want to work on the *QBAF-Py* code base, you should install some *dev dependencies* for testing.
## Tutorials
To illustrate how *QBAF-Py* works, the notebook [examples.ipynb](https://github.com/TimKam/Quantitative-Bipolar-Argumentation/blob/main/examples.ipynb) has several examples available.
The notebook is also available on [Google Colab](https://colab.research.google.com/drive/1EDOpBgmHZmZtAJx3N5wOeXVuwMaTWf8M?usp=sharing).
## Documentation
Generated documentation in html can be found [here](https://htmlpreview.github.io/?https://github.com/TimKam/Quantitative-Bipolar-Argumentation/blob/gh-pages/index.html).
You can also generate documentation in other formats making use of sphinx (you need to have sphinx installed).
The documentation is genereted from your installed libraries, so you need to install *QBAF-Py* first.
To generate the documentation, run in the [doc](https://github.com/TimKam/Quantitative-Bipolar-Argumentation/tree/main/doc) directory:
```
make
```
You will be able to see all the formats for the documentation.
For example, if you want html documentation run:
```
make html
```
## Testing
To test the package locally, first install the test requirements (`pip install -e .[dev]`) and then run `pytest` in the project's root directory.
## Acknowledgements
**Authors**: José Ruiz Alarcón - [@Ruiz968](https://github.com/Ruiz968), Timotheus Kampik - [@TimKam](https://github.com/TimKam)
This project is mainly based on the paper [Change in quantitative bipolar argumentation: Sufficient, necessary, and counterfactual explanations](https://www.sciencedirect.com/science/article/pii/S0888613X23001974) (Kampik, Čyras & Ruiz Alarcón, 2024).