Metadata-Version: 2.4
Name: satellite-camera-viewer
Version: 0.5.1
Summary: A full sky star chart showing the view from a camera mounted on a earth orbiting satellite
Author-email: Martin J Levy <mahtin@mahtin.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/mahtin/satellite-camera-viewer
Project-URL: Repository, https://github.com/mahtin/satellite-camera-viewer
Project-URL: Documentation, https://satellite-camera-viewer.readthedocs.io/
Project-URL: Bug Tracker, https://github.com/mahtin/satellite-camera-viewer/issues
Project-URL: Changelog, https://github.com/mahtin/satellite-camera-viewer/blob/main/CHANGELOG.md
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy>=7.2.0
Requires-Dist: healpy>=1.19.0
Requires-Dist: numpy>=2.4.0
Requires-Dist: matplotlib>=3.10.0
Requires-Dist: pyvista>=0.47.0
Requires-Dist: requests>=2.33.0
Requires-Dist: scipy>=1.17.0
Requires-Dist: sgp4>=2.25
Requires-Dist: spherical-geometry>=1.4.0
Requires-Dist: pillow==12.2.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Dynamic: license-file

# satellite-camera-viewer
A full sky star chart showing the view from a camera mounted on a earth orbiting satellite.

## Description
This is a Python program using `Tkinter`, `matplotlib.pyplot`, `PyVista`, and various astronomy, scientific, and satellite packages (i.e. `Astropy`, `SciPy`, and `SGP4`).
It's goal is to run a simulation of a satellite in earth orbit with an attached camera and caculate which stars would be seen in the cameras sensor.
Visualization is provided by default with camera paramaters (like focus length) being capable of being adjusted on the fly.

## Super quick start instruction

### run from source tree

```bash
$ git clone https://github.com/mahtin/satellite-camera-viewer.git
...
...
$ python -m src.SatelliteCameraViewer
$
```

### run via pip install
```bash
$ pip install git+https://github.com/mahtin/satellite-camera-viewer.git
...
...
$ satellitecameraviewer
$
```

Or use a release file directly.

```bash
$ RELEASE='0.4.1'
$ pip install https://github.com/mahtin/satellite-camera-viewer/releases/download/$RELEASE/satellite_camera_viewer-$RELEASE-py3-none-any.whl
...
...
$ satellitecameraviewer
$
```

### run via pypi and regular pip install

```bash
$ pip install satellite-camera-viewer
...
...
$ satellitecameraviewer
```

### safe install with venv

```bash
$ mkdir ~/whatever
$ cd ~/whatever
$ python3 -m venv .venv
$ cd .venv
$ source .venv/bin/activate
(.venv) $ pip install git+https://github.com/mahtin/satellite-camera-viewer.git
...
...
(.venv) $ satellitecameraviewer
(.venv) $ deactivate
$
```

## Runing the software

![Satellite Camera Viewer](/img/satellite-camera-viewer.png)

## SatelliteCamera module

All the camera pointing math is done within `SatelliteCamera` and that contains it's own [[README]](src/SatelliteCameraViewer/SatelliteCamera/README.md)

## Changelog

An automatically generated CHANGELOG is provided [here](CHANGELOG.md).

## Notes

As always, open issues or pull requests should you need via [here](https://github.com/mahtin/satellite-camera-viewer).

## Author & Copyright
Copyright (C) 2023-2026 Martin J Levy - W6LHI/G8LHI - @mahtin - https://github.com/mahtin
