Skip to content

Commit 91ef8cd

Browse files
authored
Update README.md
1 parent 253b3f3 commit 91ef8cd

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,23 @@ In this package we implement three version of SPOD
5858
To see how to use the **PySPOD** package and its user-friendly interface, you can look at the [**Tutorials**](tutorials/README.md).
5959

6060
## Installation and dependencies
61-
**PySPOD** requires `numpy`, `scipy`, `matplotlib`, `pyfftw`, `future`, `sphinx` (for the documentation). The code is developed and tested for Python 3 only.
61+
**PySPOD** requires the following Python packages:
62+
`numpy`, `scipy`, `matplotlib`, `xarray`, `netcdf4`, `h5py`, `psutil`, `tdqm`, `pyfftw`, `future`, `ffmpeg`, `sphinx` (for the documentation).
63+
If you want to run the tutorials, you would also need `ecmwf_api_client` and `cdsapi`.
64+
65+
The code is developed and tested for Python 3 only.
6266
It can be installed using `pip` or directly from the source code.
6367

68+
<!-- NOTE:
69+
- to properly install netcdf4, you might need to have a local installation of `hdf5`.
70+
- to be able to use the ffmpeg functionalities of the library (generating video of your data), you need a local installation of `ffmpeg` libraries.
71+
-->
72+
6473
### Installing via PIP
6574
Mac and Linux users can install pre-built binary packages using pip.
6675
To install the package just type:
6776
```bash
68-
> pip install --user pyspod
77+
> pip install pyspod
6978
```
7079
To uninstall the package:
7180
```bash

0 commit comments

Comments
 (0)