Skip to content

Commit

Permalink
Refactor pygsp dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
ffl096 committed Oct 18, 2024
1 parent eddf08c commit b41272d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 9 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,14 @@ for the topological domains supported in [TopoNetX](https://github.com/pyt-team/
`TopoEmbedX` is available on PyPI and can be installed using `pip`.

```bash
pip install "pygsp @ git+https://github.com/epfl-lts2/pygsp@a3412ce7696c02c8a55439e89d0c9ab8ae863269"
pip install "karateclub @ git+https://github.com/benedekrozemberczki/karateclub@cb46a91df8dcbeb2570debcf6a9d0c518107a2de"
pip install topoembedx
```

The library depends on `karateclub`, which did not receive updates on PyPI for a long time.
You have to manually install the latest version from GitHub for up-to-date NetworkX compatibility.
The library depends on `pygsp` and `karateclub`, which did not receive updates
on PyPI for a long time. You have to manually install the latest versions from
GitHub for up-to-date Python and NetworkX compatibility.

## 🦾 Getting Started

Expand Down Expand Up @@ -100,9 +102,10 @@ cd TopoEmbedX
git pull
```

3. Install a recent version of `karateclub`:
3. Install a recent version of `pygsp` and `karateclub`:

```bash
pip install "pygsp @ git+https://github.com/epfl-lts2/pygsp@a3412ce7696c02c8a55439e89d0c9ab8ae863269"
pip install "karateclub @ git+https://github.com/benedekrozemberczki/karateclub@cb46a91df8dcbeb2570debcf6a9d0c518107a2de"
```

Expand Down
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ for the topological domains supported in `TopoNetX <https://github.com/pyt-team/

.. code-block:: bash
pip install "pygsp @ git+https://github.com/epfl-lts2/pygsp@a3412ce7696c02c8a55439e89d0c9ab8ae863269"
pip install "karateclub @ git+https://github.com/benedekrozemberczki/karateclub@cb46a91df8dcbeb2570debcf6a9d0c518107a2de"
pip install topoembedx
The library depends on ``karateclub``, which did not receive updates on PyPI for a long time.
You have to manually install the latest version from GitHub for up-to-date NetworkX compatibility.
The library depends on ``pygsp`` and ``karateclub``, which did not receive
updates on PyPI for a long time. You have to manually install the latest
versions from GitHub for up-to-date Python and NetworkX compatibility.

🔍 References
-------------
Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ dependencies=[
"scipy",
"toponetx",

# We don't have a direct dependency on pygsp, but it is required by karateclub.
# The version on PyPI is severely outdated and does not work on Python 3.12.
# At least using the latest version from GitHub works for now.
"pygsp @ git+https://github.com/epfl-lts2/pygsp@a3412ce7696c02c8a55439e89d0c9ab8ae863269"
# These dependencies did not receive a new release on PyPI for a long time.
# We ask the user to manually install the latest version from GitHub separately.
"karateclub",
"pygsp"
]

[project.optional-dependencies]
Expand Down

0 comments on commit b41272d

Please sign in to comment.