Metadata-Version: 2.4
Name: pyqif
Version: 0.2
Summary: pyqif package implementing functions for Quantitative Information Flow
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Dynamic: license-file

# pyqif

Python native Quantitative Information Flow library.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `pyqif`.

```bash
pip install pyqif
```

To install locally, you can use 
```bash
pip install -e .
```

## Running

To test run modules you need to use, for example:
```bash
python -m pyqif.measure.vg
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## Acknowledgements

This library is inspired and influenced by the brilliant work done by Kostas Chatzikokolakis ([chatziko](https://github.com/chatziko)) on his [`libqif`](https://github.com/chatziko/libqif) library for C++ and Python.

## License

[GNU LGPLv3](https://choosealicense.com/licenses/lgpl-3.0/).

To understand how the various GNU licenses are compatible with each other, please refer to the GNU licenses [FAQ](https://www.gnu.org/licenses/gpl-faq.html#AllCompatibility).
