Step 2: Install MapReader

Method 1: Install from PyPI

Installing MapReader from PyPI is probably the easiest way to install MapReader.

We recommend using this method if:

  • You want to use the latest stable release of MapReader.

  • You only want to use MapReader’s classification pipeline (i.e. you do not need the text spotting functionality).

  • You do not need access to the worked examples or MapReader code.

To install mapreader without the text spotting dependencies (i.e. just the classification pipeline):

pip install mapreader

Note

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

Method 2: Install from source

Installing from source is the best way to install MapReader if you want to use the text spotting functionality or access the worked examples.

We recommend using this method if:

  • You want to keep up with the latest changes to MapReader.

  • You want to use the text spotting functionality in addition to the classification pipeline.

  • You want access to the worked examples.

  • You want access to the MapReader code (e.g. for development purposes).

This method will clone the MapReader repository onto your machine. This folder 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/maps-as-data/MapReader.git

Then, to install mapreader without the text spotting dependencies:

cd MapReader
pip install .

Note

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

Finally, to install the text spotting dependencies, you should run:

cd MapReader
pip install -r text-requirements.txt