Skip to content

Latest commit

 

History

History
120 lines (84 loc) · 3.99 KB

INSTALL.md

File metadata and controls

120 lines (84 loc) · 3.99 KB

Setup

Before attending an instructor lead version of this tutorial where you will be executing the notebooks on your local machine (not in the cloud) the necessary software should be installed and test data downloaded into the correct locations. Follow the instructions below to prepare your system.

It is recommended that anyone working through this tutorial have a minimum of 8GB of RAM memory and a CPU with at least 4 logical cores. A more powerful system is recommended for more responsive plotting and viewing of data.

Any installation issues should be filed as a bug on the tutorial GitHub repository. Create a new issue by clicking the "New issue" button near the top right of the linked page.

  1. Download the contents of the tutorial repository. You can either clone the git repository using the git command in a terminal window:

    git clone https://github.com/pytroll/tutorial-satpy-half-day

    If you do not have git installed it can be downloaded and installed from the git SCM website.

    Or you can get a copy of the repository by downloading the .zip file at the URL below and unzipping it on your system:

    https://github.com/pytroll/tutorial-satpy-half-day/archive/main.zip

  2. Install the Anaconda (Miniconda is also fine) software distribution by following the links and instructions on the Anaconda website. If this has already been installed there is no need to reinstall.

  3. Open a terminal (PowerShell or Command Prompt in Windows) and change to the root tutorial directory (where the INSTALL.md file is):

    cd /path/to/tutorial-satpy-half-day

    You will use the terminal to run the following commands.

  4. Add the conda-forge conda channel to your global configuration:

    conda config --add channels conda-forge

  5. Update the conda package manager:

    conda update -y -n base conda

    Verify that you have conda version greater than or equal to 4.6.14:

    conda --version

    NOTE: If you have run the above update command and it still didn't update to the new version. Try conda install -y -n base "conda>=4.6.14".

  6. Create a conda sub-environment specifically for this tutorial and other future Satpy work named satpy:

    conda create -y -n satpy python=3.7 satpy rasterio imageio imageio-ffmpeg cartopy geoviews notebook requests tqdm

  7. Active the new environment:

    conda activate satpy

    Note: If using older versions of conda, you may need to run source activate satpy (activate satpy on Windows).

  8. Download example data and other necessary files (~2.5GB):

    python download_data.py

    You should see SUCCESS as the last line of output.

  9. Test your installation:

    python test_install.py

    You should see SUCCESS as the last line of output.

  10. Installation is now complete. If you are attending an instructor led tutorial then you can wait for the day of the tutorial for further instructions. If you are following the tutorial on your own then continue on to the next step.

  11. Start the Jupyter Notebook server from the activated python environment so you can run the tutorial's notebooks.

    jupyter notebook

    Your web browser should open to the local notebook server. Navigate to the tutorial notebooks by clicking on the "notebooks" folder in the browser and click on the "01_introduction.ipynb" file. As you complete notebooks, you can close them and go back to this browser tab/window to access the next notebook in the series.

    You may want to click the checkbox next to completed notebooks and choose "Shutdown" near the top of the page to free any resources used by that notebook.