.. image:: https://raw.githubusercontent.com/giotto-ai/pyflagser/master/doc/images/Giotto_logo_RGB.svg :width: 590
|wheels|_ |ci|_ |Twitter-follow|_ |Slack-join|_
.. |wheels| image:: https://github.com/giotto-ai/pyflagser/actions/workflows/wheels.yml/badge.svg .. _wheels:
.. |ci| image:: https://github.com/giotto-ai/pyflagser/actions/workflows/ci.yml/badge.svg .. _ci:
.. |Twitter-follow| image:: https://img.shields.io/twitter/follow/giotto_ai?label=Follow%20%40giotto_ai&style=social .. _Twitter-follow: https://twitter.com/intent/follow?screen_name=giotto_ai
.. |Slack-join| image:: https://img.shields.io/badge/Slack-Join-yellow .. _Slack-join: https://slack.giotto.ai/
pyflagser is 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 <https://github.com/luetge/flagser>_ GitHub repository for more information.
pyflagser is the result of a collaborative effort between L2F SA <https://www.l2f.ch/>, the Laboratory for Topology and Neuroscience <https://www.epfl.ch/labs/hessbellwald-lab/> at EPFL, and the Institute of Reconfigurable & Embedded Digital Systems (REDS) <https://heig-vd.ch/en/research/reds>_ of HEIG-VD.
Dependencies
``pyflagser`` requires:
- Python (>= 3.8)
- NumPy (>= 1.17.0)
- SciPy (>= 0.17.0)
User installation
If you already have a working installation of numpy and scipy, the easiest way to install pyflagser is using pip ::
python -m pip install -U pyflagser
API reference (stable release): https://docs-pyflagser.giotto.ai
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 <https://github.com/giotto-ai/pyflagser/blob/master/CONTRIBUTING.rst>_ file.
Developer installation
C++ dependencies:
'''''''''''''''''
- C++14 compatible compiler
- CMake >= 3.9
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
.. code-block:: bash
python -m pip install -e ".[tests]"
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 <https://github.com/giotto-ai/pyflagser/blob/master/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:
---------
maintainers@giotto.ai
FAQs
Python bindings for the flagser C++ library.
We found that pyflagser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.