Step 2: Install MapReader

Method 1: Install from PyPI

If you want to use the latest stable release of MapReader and do not want/need access to the worked examples or MapReader code, we recommend installing from PyPI. This is probably the easiest way to install MapReader.

• Install mapreader:

  pip install mapreader
  

Note

To install the dev dependencies too use pip install "mapreader[dev]" instead.

Method 2: Install from source

If you want to keep up with the latest changes to MapReader, or want/need easy access to the worked examples or MapReader code, we reccommend installing from source. This method will create a MapReader directory on your machine which will contain all the MapReader code, docs and worked examples.

Note

You will need to have git installed to use this method. If you are using conda, this can be done by running conda install git. Otherwise, you should install git by following the instructions on their website.

• Clone the mapreader source code from the MapReader GitHub repository:

  git clone https://github.com/Living-with-machines/MapReader.git
  

• Install mapreader:

  cd MapReader
  pip install -v -e .
  

Note

To install the dev dependencies too use pip install -v -e ".[dev]" instead.