{"id":14977366,"url":"https://github.com/worldwidetelescope/pywwt","last_synced_at":"2025-04-05T12:02:33.615Z","repository":{"id":44899299,"uuid":"110542057","full_name":"WorldWideTelescope/pywwt","owner":"WorldWideTelescope","description":"Python interface to WorldWide Telescope :milky_way:","archived":false,"fork":false,"pushed_at":"2025-03-12T15:33:43.000Z","size":20025,"stargazers_count":51,"open_issues_count":65,"forks_count":15,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-29T11:05:57.338Z","etag":null,"topics":["astronomy","jupyter","jupyter-notebook","jupyterlab-extension","python","qt","windows"],"latest_commit_sha":null,"homepage":"https://pywwt.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WorldWideTelescope.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.rst","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"numfocus","custom":"https://numfocus.org/donate-for-worldwide-telescope"}},"created_at":"2017-11-13T11:51:56.000Z","updated_at":"2025-03-12T15:33:47.000Z","dependencies_parsed_at":"2023-12-03T17:23:41.471Z","dependency_job_id":"8f61d5b5-3437-4b62-aaf9-65d20b007e41","html_url":"https://github.com/WorldWideTelescope/pywwt","commit_stats":{"total_commits":1018,"total_committers":10,"mean_commits":101.8,"dds":0.6385068762278978,"last_synced_commit":"ef9deaec71aa149fffd68a8945d94415d221b517"},"previous_names":[],"tags_count":64,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WorldWideTelescope%2Fpywwt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WorldWideTelescope%2Fpywwt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WorldWideTelescope%2Fpywwt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WorldWideTelescope%2Fpywwt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WorldWideTelescope","download_url":"https://codeload.github.com/WorldWideTelescope/pywwt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332559,"owners_count":20921853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["astronomy","jupyter","jupyter-notebook","jupyterlab-extension","python","qt","windows"],"created_at":"2024-09-24T13:55:31.973Z","updated_at":"2025-04-05T12:02:33.589Z","avatar_url":"https://github.com/WorldWideTelescope.png","language":"Python","funding_links":["https://github.com/sponsors/numfocus","https://numfocus.org/donate-for-worldwide-telescope"],"categories":[],"sub_categories":[],"readme":"[![pywwt on PyPI](https://badge.fury.io/py/pywwt.svg)](https://badge.fury.io/py/pywwt)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7164147.svg)](https://doi.org/10.5281/zenodo.7164147)\n[![Build Status](https://dev.azure.com/aasworldwidetelescope/WWT/_apis/build/status/WorldWideTelescope.pywwt?branchName=master)](https://dev.azure.com/aasworldwidetelescope/WWT/_build/latest?definitionId=2\u0026branchName=master)\n\n# pywwt: WorldWide Telescope from Python/Jupyter\n\n🚀🚀 [Click here to try out pywwt in the cloud!][go-cloud] 🚀🚀\n\n[go-cloud]: https://mybinder.org/v2/gh/WorldWideTelescope/pywwt-notebooks/master?urlpath=lab/tree/Start%20Here.ipynb\n\n*Note: the cloud servers usually start up quickly, but if they were recently\nupdated you may have to wait a few minutes for the backing software images to be\nrebuilt.*\n\n\n## About\n\nThe [pywwt] package is the official toolkit for visualizing astronomical data in\nPython using [WorldWide Telescope][wwt] (WWT), a free, open-source astronomy\nvisualization system. WWT includes a sophisticated 4D WebGL rendering engine and\na cloud-based web service for sharing and visualizing terabytes of astronomical\ndata.\n\n[pywwt]: https://pywwt.readthedocs.io/\n[wwt]: https://worldwidetelescope.org/home\n[dnf]: https://dotnetfoundation.org/\n\n![A WWT screenshot showing exoplanets in the Kepler field overlaid on a background sky map.](docs/images/data_layers_kepler.png \"Kepler exoplanets in pywwt\")\n\nWith [pywwt] you can:\n\n* Visualize and explore astronomical data interactively in the [Jupyter and\n  JupyterLab][jupyter] environments through an HTML widget\n* Do the same in standalone applications with a [Qt][qt] widget\n* Load data from common astronomical data formats (e.g. [AstroPy\n  tables][tables]) into WWT\n* Control a running instance of the WWT Windows application\n\n[jupyter]: https://jupyter.org/\n[qt]: https://www.qt.io/\n[tables]: https://docs.astropy.org/en/stable/table/\n\n[//]: # (numfocus-fiscal-sponsor-attribution)\n\nThe WorldWide Telescope project uses an [open governance\nmodel](https://worldwidetelescope.org/about/governance/) and is fiscally\nsponsored by [NumFOCUS](https://numfocus.org/). Consider making a\n[tax-deductible donation](https://numfocus.org/donate-for-worldwide-telescope)\nto help the project pay for developer time, professional services, travel,\nworkshops, and a variety of other needs.\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://numfocus.org/donate-for-worldwide-telescope\"\u003e\n    \u003cimg height=\"60px\"\n         src=\"https://raw.githubusercontent.com/numfocus/templates/master/images/numfocus-logo.png\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\n## Installation\n\nThe full pywwt documentation, including installation instructions, can be found\nat \u003chttps://pywwt.readthedocs.io/\u003e.\n\n\n## Reporting issues\n\nIf you run into any issues, please open an issue [here](https://github.com/WorldWideTelescope/pywwt/issues).\n\n\n## For Developers: Testing\n\nTo test your pywwt checkout, use the `pytest` command.\n\nThe pywwt test suite includes a set of image tests that generate imagery using\nthe WWT Qt widget and compare the results to a set of reference images. This\ncomponent of the test suite can be finicky, even when everything is working\nproperly, because the details of the rendering are dependent upon your operating\nsystem and OpenGL implementation. If your setup is yielding visually correct\nresults, but the test suite is not passing for you, you can fix that as\ndescribed below.\n\nFor a bit more context, each “image test” generates a WWT visual and compares it\nto multiple reference images. If *any* of those images is sufficiently close to\nthe WWT result, the test passes. So if you’re running the test suite and the\ncomparisons are failing, you need add appropriate new images to the corpus.\n\nFor a test like `image_layer_equ`, the reference images are stored in the\nsubdirectory `pywwt/tests/data/refimg_image_layer_equ`. The filenames of the\nreference images within that directory don't matter, and are intentionally\nuninformative since the same reference image might match a wide variety of\nrendering platforms.\n\nIf you run the test suite with the environment variable `$PYWWT_TEST_IMAGE_DIR`\nset to a non-empty value, the WWT visuals generated during the test run will be\nsaved in the named directory. For any images that fail tests, difference images\nwith names resembling `image_layer_equ_vs_a.png` will also be saved. So to\nupdate the image corpus so that the test suite passes for you, run the test\nsuite in this mode, then copy the failing images to the appropriate reference\nimage data directories. Don't forget to `git add` the new files! And you should\nalso verify that your new images do in fact look “reasonable” compared to what’s\nexpected for the test.\n\nYou can also run `python -m pywwt.tests $imgdir1 $imgdir2 ...`, where `$imgdirN`\nare paths to directories or Zip files containing images generated during one or\nmore test runs. This will compare those images to the current corpus of\nreference images, and indicate whether there are images in the reference corpus\nthat could potentially be removed. **Note**, however, that this is only safe if\nyour collection of `$imgdirN` spans *all* pywwt rendering platforms of interest.\nIf there’s a developer that runs the test suite on MacOS 10.10 and your\ncollection doesn't include those samples, you run the risk of breaking the test\nsuite for that person if you remove the reference files that they need. That\nbeing said, it is quite possible for reference images to get out-of-date as the\nrendering code and test suite evolve. On the third hand, deleting files from\nthe Git repository doesn't actually make it smaller, so removing old reference\nimages only helps a bit with housekeeping.\n\n\n## Continuous Integration and Deployment\n\nThis repository uses [Cranko] to automate release workflows. This automation is\nessential to the smooth and reproducible deployment of the WWT web services.\n\n[Cranko]: https://pkgw.github.io/cranko/\n\n\n## Getting involved\n\nWe love it when people get involved in the WWT community! You can get started\nby [participating in our user forum] or by\n[signing up for our low-traffic newsletter]. If you would like to help make\nWWT better, our [Contributor Hub] aims to be your one-stop shop for\ninformation about how to contribute to the project, with the\n[Contributors’ Guide] being the first thing you should read. Here on GitHub we\noperate with a standard [fork-and-pull] model.\n\n[participating in our user forum]: https://wwt-forum.org/\n[signing up for our low-traffic newsletter]: https://bit.ly/wwt-signup\n[Contributor Hub]: https://worldwidetelescope.github.io/\n[Contributors’ Guide]: https://worldwidetelescope.github.io/contributing/\n[fork-and-pull]: https://help.github.com/en/articles/about-collaborative-development-models\n\nAll participation in WWT communities is conditioned on your adherence to the\n[WWT Code of Conduct], which basically says that you should not be a jerk.\n\n[WWT Code of Conduct]: https://worldwidetelescope.github.io/code-of-conduct/\n\n\n## Acknowledgments\n\nWork on the WorldWide Telescope system has been supported by the [American\nAstronomical Society] (AAS), the [.NET Foundation], and other partners. See [the\nWWT user website][acks] for details.\n\n[American Astronomical Society]: https://aas.org/\n[.NET Foundation]: https://dotnetfoundation.org/\n[acks]: https://worldwidetelescope.org/about/acknowledgments/\n\n\n## Legalities\n\nThe WWT code is licensed under the [MIT License]. The copyright to the code is\nowned by the [.NET Foundation].\n\n[MIT License]: https://opensource.org/licenses/MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworldwidetelescope%2Fpywwt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworldwidetelescope%2Fpywwt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworldwidetelescope%2Fpywwt/lists"}