From d4ff76b9814c371004b18a4f830b7a773a00e75e Mon Sep 17 00:00:00 2001 From: Jan Griesfeller Date: Mon, 15 Jan 2024 16:52:12 +0100 Subject: [PATCH] updated documentation --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 57c36a7..2c41976 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,21 @@ implementations of readers for the pyaerocom project using pyaro as interface ## Installation -`python -m pip install 'pyaro-readers@git+https://github.com/metno/pyaro-readers.git'` +`python -m pip install 'pyaro-readers@git+https://github.com/metno/pyaro-readers.git'` This will install pyaro and pyaro-readers and all their dependencies. +In case the installation failed, your pip might be too old. You can update that via: + +`python3 -m venv --upgrade-deps --prompt pyaero pyaero-env` + +(installs in a new virtual environment named `pyaero-env` in the current directory) + +Then activate the virtual environment via `pyaero-env/bin/activate` and install as above. + +Detailed documentation about virtual environments in Python and how to use them can be found [here](https://docs.python.org/3/library/venv.html). + + ## Supported readers ### aeronetsunreader Reader for aeronet sun version 3 data (https://aeronet.gsfc.nasa.gov/new_web/download_all_v3_aod.html).