Transparent desktop sky viewer with stars, planets, eclipses, and optional real-time satellite cloud overlay.
Project description
zstarview
Transparent desktop sky viewer with stars, planets, eclipses, optional real-time satellite cloud overlay, optional terrain horizon overlay, and optional urban outline overlay.
Urban outline examples from several cities worldwide:
| Near Tokyo Tower, Tokyo | Downtown Dubai | Marina Bay, Singapore | Circular Quay, Sydney |
Install
Recommended:
Prerequisite for the urban outline overlay: install the overturemaps CLI separately.
Installation: https://pypi.org/project/overturemaps/
Confirm it with:
overturemaps --help
pipx install zstarview
Or with pip:
pip install zstarview
Note: Windows on Arm64 is currently not supported for installation. As of 2026-03-15, native dependencies such as
shapelycan fail there because they may require a source build.
Quick Start
zstarview [options] [location]
Examples:
zstarview Tokyo
zstarview "Tokyo Skytree"
zstarview "35.68;139.76"
zstarview --place "Matsue Station" --place-countrycode jp
zstarview -Z E -A 25 Tokyo
Highlights
- Deep-sky objects: named galaxies/open clusters/globular clusters are shown as soft blue extents.
- Asterism overlay: popular line patterns rather than formal IAU constellation boundaries are shown as dim ambient lines.
- Solar-system bodies: supports Sun, Moon, and major planets.
- Flexible location input: specify the observer location through the CLI argument using a city name, tower name, mountain name, direct latitude/longitude input, or online place/station search via Nominatim.
- Adjustable view center: adjust the view center with CLI options
-Aand-Z, or with the arrow keys. - Satellite cloud imagery: real-time Himawari/GOES satellite data are downloaded and rendered as a stylized hatched overlay.
- Terrain horizon and ground fill: Copernicus DEM data can be downloaded to render the local terrain skyline and ground region below the horizon.
- Urban outline overlay: major rooflines are drawn as a white overlay for the current viewpoint. In some skyscraper-heavy cities, distant skyscrapers can also be added from within a 10km radius.
- Never-rises region: the celestial region that never rises above the horizon for the observer's latitude is shown in a red tint.
- Python support: routinely tested on CPython 3.10, 3.11, 3.12, and 3.13.
Common Options
--place QUERY--place-countrycode CODE--place-lang LANG--cloud-opacity 0.0..1.0--terrain-horizon-opacity 0.0..1.0--urban-outline-opacity 0.0..1.0--observer-height-m METERS--datetime "YYYY-MM-DD HH[:MM[:SS]] [TZ]"
Notes:
--placeuses the public OpenStreetMap Nominatim search service and sends a single request with a User-Agent andAccept-Language.- Satellite cloud rendering downloads Himawari/GOES data from public S3 buckets.
- Terrain horizon rendering downloads Copernicus DEM tiles on first use and reuses cached data later.
Code, Data Licenses, and Credits
- Code: MIT License. See
LICENSE. - Bundled and runtime-fetched data may be subject to their own licenses, attribution rules, or service terms.
- See the main project README for the full credits and third-party data notes.
Links
- Homepage: https://github.com/tos-kamiya/zstarview
- Documentation: https://github.com/tos-kamiya/zstarview#readme
- Issues: https://github.com/tos-kamiya/zstarview/issues
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zstarview-1.0.6.tar.gz.
File metadata
- Download URL: zstarview-1.0.6.tar.gz
- Upload date:
- Size: 44.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
11d7946842c0b10ee65b35a03cd68e7459c1ba1d0d8e922217f13eb2da672ff4
|
|
| MD5 |
4237d5ad1096f49bf660557b7222ec77
|
|
| BLAKE2b-256 |
63f2978cfcf09371e38d9356dab949f3e6939d31458d7a572cc32b0ccb7874d9
|
File details
Details for the file zstarview-1.0.6-py3-none-any.whl.
File metadata
- Download URL: zstarview-1.0.6-py3-none-any.whl
- Upload date:
- Size: 42.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
142fd0dbab5537cb8306c8b351203aaa0049a6c73326c43f3db673262c85fb0b
|
|
| MD5 |
fb1f2057bf71f7de484ecab4b23a5817
|
|
| BLAKE2b-256 |
c89cfabef2d58d7400288502c2a969929b5ac89e4cf342f33edac47b26eb39bb
|