Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

MapReader

All Contributors PyPI License Integration Tests badge DOI CodeCov JOSS Paper

Table of Contents


What is MapReader?

MapReader is a open-source python library for exploring and analyzing map images at scale.

It contains two different pipelines:

  • Classification pipeline: This pipeline enables users to fine-tune a classification model and predict the labels of patches created from a parent image.
  • Text spotting pipeline: This pipeline enables users to detect and recognize text in map images.

MapReader was developed in the Living with Machines project to analyze large collections of historical maps but is a generalizable computer vision tool which can be applied to any images in a wide variety of domains.

Overview

MapReader classification pipeline

The MapReader classification pipeline enables users to train a classification model to recognize visual features within map images and to identify patches containing these features across entire map collections:

MapReader pipeline

MapReader text spotting pipeline

The MapReader text spotting pipeline enables users to detect and recognize text in map images using a pre-trained text spotting model:

MapReader text spotting pipeline

Documentation

The MapReader documentation can be found at https://mapreader.readthedocs.io/en/latest/.

New users should refer to the Installation instructions and Input guidance for help with the initial set up of MapReader.

All users should refer to our User Guide for guidance on how to use MapReader. This contains end-to-end instructions on how to use the MapReader pipeline.

Developers and contributors may also want to refer to the API documentation and Contribution guide for guidance on how to contribute to the MapReader package.

Stay in touch

All users are encouraged to join our community! Please refer to the Community and contributions page for information on ways to get involved.

Join our Slack workspace! Please fill out this form to receive an invitation to the Slack workspace.

What is included in this repo?

This repository contains everything needed for running MapReader.

The repository is structured as follows:

  • mapreader/: Contains the source code for the MapReader library.
  • docs/: Contains the documentation for the MapReader library.
  • tests/ and test_text_spotting/: Contains the tests for the MapReader library.

What is not included in this repo?

Our worked examples can be found in the mapreader-examples repository.

We also have a number of other MapReader and map related repositories which can be found on the maps-as-data GitHub organisation page.

How to cite MapReader

If you use MapReader in your work, please cite:

  • Our JOSS paper - to acknowledge the software irrespective of the version you used.
  • Our Zenodo record - to acknowledge the specific version of the software you used (or use the "Cite all versions?" option if your specific version isn't there).
  • Optionally, our SIGSPATIAL paper to acknowledge the development of the software and the research behind it.

Acknowledgements

This work was supported by Living with Machines (AHRC grant AH/S01179X/1), Data/Culture (AHRC grant AH/Y00745X/1) and The Alan Turing Institute (EPSRC grant EP/N510129/1).

Living with Machines, funded by the UK Research and Innovation (UKRI) Strategic Priority Fund, is a multidisciplinary collaboration delivered by the Arts and Humanities Research Council (AHRC), with The Alan Turing Institute, the British Library and the Universities of Cambridge, East Anglia, Exeter, and Queen Mary University of London.

Maps above reproduced with the permission of the National Library of Scotland https://maps.nls.uk/index.html

Contributors

Katie McDonough
Katie McDonough

🔬 🤔 📖 📆 👀 📢 ✅
Daniel C.S. Wilson
Daniel C.S. Wilson

🔬 🤔 📢 📖
Kasra Hosseini
Kasra Hosseini

💻 🤔 🔬 👀 📢
Rosie Wood
Rosie Wood

💻 📖 🤔 📢 ✅ 👀 🚧 🔬
Kalle Westerling
Kalle Westerling

💻 📖 🚧 👀 📢
Chris Fleet
Chris Fleet

🔣
Kaspar Beelen
Kaspar Beelen

🤔 👀 🔬
Andy Smith
Andy Smith

💻 📖 🧑‍🏫 👀
Adam Cox
Adam Cox

💻 ⚠️

Metadata

Release files for mapreader 1.8.3.post0.dev4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mapreader 1.8.3.post0.dev4
File Size Uploaded Provenance Actions
mapreader-1.8.3.post0.dev4.tar.gz 126.0 kB Without provenance Details for mapreader-1.8.3.post0.dev4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mapreader 1.8.3.post0.dev4
File Interpreter ABI Platform Actions
mapreader-1.8.3.post0.dev4-py3-none-any.whl Python 3 none any Details for mapreader-1.8.3.post0.dev4-py3-none-any.whl

Total release size: 241.3 kB

Release files / mapreader-1.8.3.post0.dev4.tar.gz

Download URL mapreader-1.8.3.post0.dev4.tar.gz
Size 126.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5ac3308d7a4c8671d4f6abb474bc2328cc5d5061f9eb1fca445650ffe0f35f33
BLAKE2b-256 checksum
How to use checksums
6f6831da1d62921623ba21fcc6b3703e914c014a772c10fe0761d9727565a0cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / mapreader-1.8.3.post0.dev4-py3-none-any.whl

Download URL mapreader-1.8.3.post0.dev4-py3-none-any.whl
Size 115.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0247049a5ce7f593170bca20885c88553a55e87f61771fe3b744a18ab0d10e6d
BLAKE2b-256 checksum
How to use checksums
df75c8b745706933e86eb7a855652127310587879f98b9d98c8bb34346cd2b60
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for mapreader 1.8.3.post0.dev4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page