Star Plot for Glasgow

Scripts in this repository generate images of the night sky as seen in Glasgow, UK using the Starplot library.

If you just want to generate plots, rather than contribute to the code, you can do so for free at: https://starplot-glasgow.onrender.com

Examples

Below are some examples of the two types of plots you can create.

A Zenith Star Plot from Glasgow

A Horizon Star Plot from Glasgow

Repository Layout

📁 starplot-glasgow/
│
├── 📁 .github/workflows/              # GitHub Workflow files
│   └── main.yml                       # CI configuration for github: Pylint and Mypy
|
├── 📁 .streamlit/config/               # Web app configuration files
│   └── config.toml                     # Configuration for render to use streamlit
│
├── 📁 images/                         # Image assets
│   └── glasgow_horizon.png           # Image generated by scripts/glasgow_horizon.py
│   └── glasgow_zenith.py             # Image generated by scripts/glasgow_zenith.py
│
├── 📁 scripts/                        # Scripts for generating star plot images
│   └── __init__.py                  # Empty file, for module creation
│   └── glasgow_horizon.py           # Code for generating a horizon image
│   └── glasgow_zenith.py            # Code for generating a zenith image
│
├── .gitignore               # Files/folders to ignore in Git
├── app.py                   # Code for running the streamlit web app
├── LICENSE.MD               # License file
├── mypy.ini                 # Configuration for mypy
├── README.MD                # Project overview
└── requirements.txt        # List of python package dependencies

Installation

Make sure Python 3.13 is installed on your system before proceeding with the installation. Follow these steps to set up the project in a Python virtual environment:

1. Clone the repository

   git clone https://github.com/bprobert97/starplot-glasgow.git

2. Create a virtual environment

   python -m venv venv

3. Activate the virtual environment

   On Windows:

   venv\Scripts\activate

   On macOS/Linux:

   source venv/bin/activate

4. Install dependencies

   pip install -r requirements.txt

Usage

To run the streamlist web app, in your terminal run:

   streamlit run app.py

This will then spin up a local instance of the web app.