Skip to content

Commit c37e52c

Browse files
authored
Revise installation section in README.md
Updated Python version compatibility and improved wording in installation instructions.
1 parent b8ab604 commit c37e52c

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,12 +147,11 @@ overlap_x2 = no.return_label_overlap(k=10)
147147
> Allione et al., arXiv (2025)
148148
149149
# Installation
150-
The package is compatible with the Python versions 3.8, 3.9, 3.10, 3.11, and 3.12.
151-
The methods of the classes ```DiffImbalance``` and ```CausalGraph``` are only compatible with Python>=3.9.
150+
The package is compatible with the Python versions 3.10, 3.11, 3.12, 3.13, and 3.14.
152151
We currently only support Unix-based systems, including Linux and macOS.
153152
For Windows machines, we suggest using the [Windows Subsystem for Linux (WSL)](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux).
154153

155-
The package requires `numpy`, `scipy`, `scikit-learn`, `jax`, `jaxlib` and `matplotlib` for the visualizations.
154+
The package requires `numpy`, `scipy`, `scikit-learn`, `jax`, `jaxlib`, and `matplotlib` for the visualizations.
156155

157156
The package contains Cython-generated C extensions that are automatically compiled during installation.
158157

@@ -169,7 +168,7 @@ and install it with pip as follows:
169168
pip install git+https://github.com/sissa-data-science/DADApy
170169
```
171170

172-
Alternatively, if you'd like to modify the implementation of some function locally you can download the repository and install the package with:
171+
Alternatively, if you'd like to modify the implementation of some function locally, you can download the repository and install the package with:
173172

174173
```sh
175174
git clone https://github.com/sissa-data-science/DADApy.git
@@ -178,13 +177,13 @@ python setup.py build_ext --inplace
178177
pip install .
179178
```
180179

181-
The methods of the classes ```DiffImbalance``` and ```CausalGraph``` can be run on GPU, using a suitable installation of JAX on a GPU platform. The code has been tested using JAX v0.4.30 with CUDA 12, which can be installed with:
180+
The methods of the classes ```DiffImbalance``` and ```CausalGraph``` can be run on a GPU, using a suitable installation of JAX on a GPU platform. The code has been tested using JAX v0.4.30 with CUDA 12, which can be installed with:
182181

183182
```sh
184183
pip install --upgrade "jax[cuda12_pip]==0.4.30" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
185184
```
186185

187-
For more information on the installation of the JAX library on GPUs see the official [repository](https://github.com/google/jax?tab=readme-ov-file#installation).
186+
For more information on the installation of the JAX library on GPUs, see the official [repository](https://github.com/google/jax?tab=readme-ov-file#installation).
188187

189188

190189
# Citing DADApy

0 commit comments

Comments
 (0)