Bellpedia

Table of Contents

1. About The Module
   • Built With
2. Getting Started
   • Prerequisites and Installation
3. Usage
4. Examples
5. License
6. Contact

About The Project

Python module to explore change bell ringing bell towers throughout the UK and the world.

Built With

The module was constructed using the following libraries,

• Python

• OpenStreetMap

The bell tower information is collated directly from Dove's Guide,

• Dove's Guide

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites and Installation

This is an example of how to list things you need to use the software and how to install them.

1. Clone the repo,

   git clone https://github.com/sephwalker321/Bellpedia.git
   

2. Running the install script, Linux:

./install_Linux.sh

Windows:

install_Windows.bat

3. Source the virtual environment, Linux:

source venv/bin/activate

Windows:

venv\Scripts\activate

Alternatively see requirements.txt and install manually.

Usage

A Jupyter Notebook is provided for the collation of data and plotting.

1. Notebooks/quickstart.ipynb example data manipulation and plotting.

User tower infomation can be used to create a list containing all tower information. Example excel sheet can be found in my_data/ and its use is demonstraighted in the quickstart notebook.

Examples

Here are some example plots generated across all full-circle ring bell towers.

A set of summary histograms can also be produced:

License

Distributed under the Creative Commons Attribution 4.0 International Public License. See LICENSE for more information.

Contact

For any issues or questions contact Joseph Walker

Project Link: https://github.com/sephwalker321/Bellpedia.git