pyflagser 0.3.0

Python bindings for the flagser C++ library.

pyflagser

pyflagser s a python API for the flagser C++ library by Daniel Lütgehetmann which computes the homology of directed flag complexes. Please check out the original luetge/flagser GitHub repository for more information.

Website: https://giotto.ai

Project genesis

pyflagser is the result of a collaborative effort between L2F SA, the Laboratory for Topology and Neuroscience at EPFL, and the Institute of Reconfigurable & Embedded Digital Systems (REDS) of HEIG-VD.

Installation

Dependencies

pyflagser requires:

• Python (>= 3.6)

• numpy (>= 1.17.0)

• scipy (>= 0.17.0)

For running the examples jupyter, matplotlib and plotly are required.

User installation

If you already have a working installation of numpy and scipy, the easiest way to install pyflagser is using pip

pip install -U pyflagser

Documentation

• HTML documentation (stable release): https://docs-pyflagser.giotto.ai

Contributing

We welcome new contributors of all experience levels. The Giotto community goals are to be helpful, welcoming, and effective. To learn more about making a contribution to pyflagser, please see the CONTRIBUTING.rst file.

Developer installation

C++ dependencies:

• C++14 compatible compiler

• CMake >= 3.9

• Boost >= 1.56

Source code

You can check the latest sources with the command:

git clone https://github.com/giotto-ai/pyflagser.git

To install:

From the cloned repository’s root directory, run

pip install -e .

This way, you can pull the library’s latest changes and make them immediately available on your machine.

Testing

After installation, you can launch the test suite from outside the source directory:

pytest pyflagser

Changelog

See the RELEASE.rst file for a history of notable changes to pyflagser.

Important links

• Official source code repo: https://github.com/giotto-ai/pyflagser

• Download releases: https://pypi.org/project/pyflagser/

• Issue tracker: https://github.com/giotto-ai/pyflagser/issues

Contacts:

[e-mail]