Skip to content

Commit 315e4d3

Browse files
committed
docs: Remove PyTorch section and update MPI recommendation
- Remove PyTorch Issues troubleshooting section (not relevant to Tempest) - Update MPI Support to recommend ezmpi package instead of mpi4py - Clarify that ezmpi provides MPIPool class for MPI parallelization - Update note about MPI runtime requirements
1 parent e3389a0 commit 315e4d3

1 file changed

Lines changed: 6 additions & 14 deletions

File tree

docs/installation.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,16 @@ The `-e` flag installs the package in "editable" mode, which is useful for devel
5656

5757
### MPI Support
5858

59-
For running Tempest with MPI parallelization (useful for HPC clusters), install `mpi4py`:
59+
For running Tempest with MPI parallelization (useful for HPC clusters), we recommend installing `ezmpi`:
6060

6161
```bash
62-
pip install mpi4py
62+
pip install ezmpi
6363
```
6464

65-
!!! note "MPI Installation"
66-
Make sure you have an MPI implementation installed on your system (e.g., OpenMPI, MPICH) before installing mpi4py.
65+
This will automatically install `mpi4py` and provide the `MPIPool` class used by Tempest for MPI parallelization.
66+
67+
!!! note "MPI Runtime"
68+
Make sure you have an MPI implementation installed on your system (e.g., OpenMPI, MPICH) before installing ezmpi.
6769

6870
### Development Dependencies
6971

@@ -102,16 +104,6 @@ pytest tests/
102104

103105
## Troubleshooting
104106

105-
### PyTorch Issues
106-
107-
If you encounter issues with PyTorch, try installing it separately first:
108-
109-
```bash
110-
pip install torch
111-
```
112-
113-
For GPU support, follow the [PyTorch installation guide](https://pytorch.org/get-started/locally/).
114-
115107
### Permission Errors
116108

117109
If you get permission errors during installation, try:

0 commit comments

Comments
 (0)