Metadata-Version: 2.4
Name: badweathermounttester
Version: 0.9.0
Summary: Test telescope mount periodic error indoors using a simulated star on a monitor
Project-URL: Homepage, https://github.com/jscheidtmann/BadWeatherMountTester
Project-URL: Repository, https://github.com/jscheidtmann/BadWeatherMountTester
Project-URL: Issues, https://github.com/jscheidtmann/BadWeatherMountTester/issues
Author: Jens Scheidtmann
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Keywords: PHD2,astronomy,guiding,mount,periodic error,telescope
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.10
Requires-Dist: flask-babel>=4.0.0
Requires-Dist: flask>=3.0.0
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numpy>=1.24.0
Requires-Dist: pillow>=10.0.0
Requires-Dist: pygame>=2.5.0
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: waitress>=3.0.0
Provides-Extra: dev
Requires-Dist: babel>=2.14.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Requires-Dist: zensical>=0.0.21; extra == 'dev'
Description-Content-Type: text/markdown

# Bad Weather Mount Tester

[![Python application](https://github.com/jscheidtmann/BadWeatherMountTester/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/jscheidtmann/BadWeatherMountTester/actions/workflows/python-app.yml)
[![PyPI version](https://img.shields.io/pypi/v/BadWeatherMountTester)](https://pypi.org/project/BadWeatherMountTester/)
[![GitHub release](https://img.shields.io/github/v/release/jscheidtmann/BadWeatherMountTester)](https://github.com/jscheidtmann/BadWeatherMountTester/releases/latest)
[![Release date](https://img.shields.io/github/release-date/jscheidtmann/BadWeatherMountTester)](https://github.com/jscheidtmann/BadWeatherMountTester/releases/latest)
[![Dependencies](https://img.shields.io/librariesio/release/pypi/BadWeatherMountTester)](https://libraries.io/pypi/BadWeatherMountTester)

  Bad Weather Mount Tester Logo

When you buy a new telescope mount, the first things to do is to measure the periodic error, because if the periodic error is really high, you would like to
complain and send it back as fast as possible. Unfortunately, most of the time there will be bad weather after buying astro gear for an indefinite amount of time.

**Bad Weather Mount Tester to the rescue!**

Using this program you can test the periodic error of your mount any time, any place, provided you have a spare computer and monitor and a little bit of space.

## Documentation

The full user manual is available at <https://jscheidtmann.github.io/BadWeatherMountTester/>.

## How to Install

### From PyPI (all platforms)

Using pip:

```bash
pip install BadWeatherMountTester
```

Or using [pipx](https://pipx.pypa.io/) for an isolated install:

```bash
pipx install BadWeatherMountTester
```

Then run the application:

```bash
bwmt
```

### From GitHub Releases (pre-built binaries)

Download the latest release from the [GitHub Releases](https://github.com/jscheidtmann/BadWeatherMountTester/releases) page.

- **Linux:** Download the `.tar.gz` archive, extract it, and run `./bwmt`
- **Windows:** Download the `.zip` archive, extract it, and run `bwmt.exe`
- **macOS:** Download the `.tar.gz` archive, extract it, and run `./bwmt`

### From Source

```bash
git clone https://github.com/jscheidtmann/BadWeatherMountTester.git
cd BadWeatherMountTester
```

Install [uv](https://docs.astral.sh/uv/) if you don't have it, then:

```bash
uv sync
uv run bwmt
```

## How to Contribute

1. Fork the repository and clone your fork
2. Install development dependencies:
   ```bash
   uv sync --dev
   ```
3. Install [just](https://just.systems/) for common development tasks:

   | Platform | Command |
   |----------|---------|
   | Windows | `winget install Casey.Just` |
   | macOS | `brew install just` |
   | Linux / Raspberry Pi | `curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh \| bash -s -- --to ~/.local/bin` |

4. List all available recipes:
   ```bash
   just
   ```
   Key recipes:

   | Recipe | Description |
   |--------|-------------|
   | `just test` | Run the test suite |
   | `just lint` | Run ruff and flake8 |
   | `just translations` | Extract strings, update `.po` files, compile `.mo` files |
   | `just compile-translations` | Compile `.po` → `.mo` only |
   | `just run` | Run the application |

5. **Internationalization:** The project supports German, English, and French via Flask-Babel. Translation files live in `src/badweathermounttester/translations/`. After editing `.po` files run `just compile-translations`.
6. Submit a pull request against `main`

## CHANGELOG.md

This project keeps a [CHANGELOG](https://github.com/jscheidtmann/BadWeatherMountTester/blob/main/CHANGELOG.md).

# Credit

This software is based on the idea by [Klaus Weyer from Solingen, Germany](https://web.archive.org/web/20241013053734/https://watchgear.de/SWMT/SWMT.html). Rest in Peace, Klaus!

# Author, Copyright & License

Copyright (c) 2026 Jens Scheidtmann and contributors (see CONTRIBUTORS.md)

This file is part of BWMT, the Bad Weather Mount Tester.

BWMT is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

BWMT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with BWMT.  If not, see <http://www.gnu.org/licenses/>.
