Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.48 KB

README.md

File metadata and controls

41 lines (25 loc) · 1.48 KB

Code style: black Main Checked with mypy codecov

graphs

Playground for PRable stuff into networkx. Do not use this repo unless you are working with the pywhy team on networkx-implementations.

Base classes for graphs that extend networkx to be used in other PyWhy libraries.

Please refer to the networkx code to see how things should be structured. The intention is to PR functionality in this repo directly by:

  1. copy-pasting relevant files into networkx
  2. find+replace "graphs" with "networkx" and
  3. then submitting PR

Documentation

See the development version documentation.

Installation

Installation is best done via pip installing directly from the github API.

pip install -U https://github.com/pywhy/graphs/archive/main.zip

Dependencies

Minimally, graphs requires:

* Python (>=3.8)
* NumPy
* SciPy
* Networkx

User Installation

To install the package from github, clone the repository and then cd into the directory:

pip install -e .