Skip to content

Add PyPI warning and OS compatibility notes (fixes #179) #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AmanKushwaha-17 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add PyPI warning and OS compatibility notes (fixes #179) #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a410e1
Add PyPI warning and OS compatibility notes (fixes #179)
AmanKushwaha-17 Nov 29, 2025
a2dc33b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,55 @@ This library can be installed through
pip install graph-weather
```


> ⚠️ **Important Note about PyPI**
>
> The PyPI package (`pip install graph-weather`) is currently out-of-date and may raise:
>
> ```
> ModuleNotFoundError: graph_weather.data.nnjai_wrapp
> ```
>
> This happens because the PyPI wheel is older than the GitHub version.
>
> To avoid this issue, install the latest version directly from GitHub:
>
> ```bash
> pip install git+https://github.com/openclimatefix/graph_weather.git
> ```
>
> Alternatively, you can clone and install locally:
>
> ```bash
> git clone https://github.com/openclimatefix/graph_weather.git
> cd graph_weather
> pip install -e .
> ```


Alternatively, you can install the latest version from the repository easily with `pixi`:

```bash
pixi install # `-e cuda` for GPU support, `-e cpu` for CPU-only
```


## Operating System Compatibility

`graph_weather` can be installed on Linux, macOS, and Windows.
However, most contributors and CI environments use Linux or WSL2, so installation tends to be smoother on Linux-like systems.

### Windows Users

Windows is supported, but some users may encounter issues with
virtual environments, paths, or CUDA/PyTorch compatibility.

If you run into difficulties with native Windows installation, you may find it
easier to use **WSL2**, which provides a Linux-like environment used by many developers.
Any WSL2 Linux distribution (e.g., Ubuntu) works.



## Example Usage

The models generate the graphs internally, so the only thing that needs to be passed to the model is the node features
Expand Down