Skip to content

Commit

Permalink
Merge 4c326f5 into 7106a7f
Browse files Browse the repository at this point in the history
  • Loading branch information
pkgw authored Sep 15, 2023
2 parents 7106a7f + 4c326f5 commit a402864
Show file tree
Hide file tree
Showing 25 changed files with 150 additions and 120 deletions.
5 changes: 1 addition & 4 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@ graft pywwt/web_static

# Documentation
graft docs
exclude docs/\#*
prune docs/build
prune docs/gh-pages
prune docs/dist
prune docs/_build

# Tests
graft tests
Expand Down
103 changes: 76 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,27 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7164147.svg)](https://doi.org/10.5281/zenodo.7164147)
[![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&branchName=master)

# pywwt: AAS WorldWide Telescope from Python/Jupyter
# pywwt: WorldWide Telescope from Python/Jupyter

🚀🚀 [Click here to try out pywwt in the cloud!][go-cloud] 🚀🚀

[go-cloud]: https://mybinder.org/v2/gh/WorldWideTelescope/pywwt-notebooks/master?urlpath=lab/tree/Start%20Here.ipynb

*Note: our cloud servers usually start up quickly, but if they were recently
*Note: the cloud servers usually start up quickly, but if they were recently
updated you may have to wait a few minutes for the backing software images to be
rebuilt.*


## About

The [pywwt] package is the official toolkit for visualizing astronomical data in
Python using [AAS][aas] [WorldWide Telescope][wwt] (WWT). WWT is a free,
open-source tool for visually exploring humanity’s scientific understanding of
the Universe. It includes a sophisticated 4D WebGL rendering engine and a
cloud-based web service for sharing and visualizing terabytes of astronomical
data. WWT is brought to you by the non-profit [American Astronomical Society][aas]
(AAS), the major organization of professional astronomers in North America, and
the [.NET Foundation][dnf].
Python using [WorldWide Telescope][wwt] (WWT), a free, open-source astronomy
visualization system. WWT includes a sophisticated 4D WebGL rendering engine and
a cloud-based web service for sharing and visualizing terabytes of astronomical
data.

[pywwt]: https://pywwt.readthedocs.io/
[aas]: https://aas.org/
[wwt]: http://www.worldwidetelescope.org/home
[wwt]: https://worldwidetelescope.org/home
[dnf]: https://dotnetfoundation.org/

![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")
Expand All @@ -43,8 +40,32 @@ With [pywwt] you can:
[qt]: https://www.qt.io/
[tables]: https://docs.astropy.org/en/stable/table/

The full documentation, including installation instructions, can be found at
<http://pywwt.readthedocs.io/>.
[//]: # (numfocus-fiscal-sponsor-attribution)

The WorldWide Telescope project uses an [open governance
model](https://worldwidetelescope.org/about/governance/) and is fiscally
sponsored by [NumFOCUS](https://numfocus.org/). Consider making a
[tax-deductible donation](https://numfocus.org/donate-for-worldwide-telescope)
to help the project pay for developer time, professional services, travel,
workshops, and a variety of other needs.

<div align="center">
<a href="https://numfocus.org/donate-for-worldwide-telescope">
<img height="60px"
src="https://raw.githubusercontent.com/numfocus/templates/master/images/numfocus-logo.png">
</a>
</div>


## Installation

The full pywwt documentation, including installation instructions, can be found
at <https://pywwt.readthedocs.io/>.


## Reporting issues

If you run into any issues, please open an issue [here](https://github.com/WorldWideTelescope/pywwt/issues).


## For Developers: Testing
Expand Down Expand Up @@ -95,22 +116,50 @@ the Git repository doesn't actually make it smaller, so removing old reference
images only helps a bit with housekeeping.


## Reporting issues
## Continuous Integration and Deployment

If you run into any issues, please open an issue [here](https://github.com/WorldWideTelescope/pywwt/issues).
This repository uses [Cranko] to automate release workflows. This automation is
essential to the smooth and reproducible deployment of the WWT web services.

[Cranko]: https://pkgw.github.io/cranko/


## Getting involved

We love it when people get involved in the WWT community! You can get started
by [participating in our user forum] or by
[signing up for our low-traffic newsletter]. If you would like to help make
WWT better, our [Contributor Hub] aims to be your one-stop shop for
information about how to contribute to the project, with the
[Contributors’ Guide] being the first thing you should read. Here on GitHub we
operate with a standard [fork-and-pull] model.

[participating in our user forum]: https://wwt-forum.org/
[signing up for our low-traffic newsletter]: https://bit.ly/wwt-signup
[Contributor Hub]: https://worldwidetelescope.github.io/
[Contributors’ Guide]: https://worldwidetelescope.github.io/contributing/
[fork-and-pull]: https://help.github.com/en/articles/about-collaborative-development-models

All participation in WWT communities is conditioned on your adherence to the
[WWT Code of Conduct], which basically says that you should not be a jerk.

[WWT Code of Conduct]: https://worldwidetelescope.github.io/code-of-conduct/


## Acknowledgments

The AAS WorldWide Telescope (WWT) system, including pywwt, is a [.NET
Foundation][dnf] project. Work on WWT and pywwt has been supported by the
[American Astronomical Society][aas] (AAS), the US [National Science Foundation][nsf]
(grants [1550701], [1642446], and [2004840]), the [Gordon and Betty Moore Foundation][moore], and
[Microsoft][msft].

[nsf]: https://www.nsf.gov/
[1550701]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1550701
[1642446]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1642446
[2004840]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=2004840
[moore]: https://www.moore.org/
[msft]: https://microsoft.com/
Work on the WorldWide Telescope system has been supported by the [American
Astronomical Society] (AAS), the [.NET Foundation], and other partners. See [the
WWT user website][acks] for details.

[American Astronomical Society]: https://aas.org/
[.NET Foundation]: https://dotnetfoundation.org/
[acks]: https://worldwidetelescope.org/about/acknowledgments/


## Legalities

The WWT code is licensed under the [MIT License]. The copyright to the code is
owned by the [.NET Foundation].

[MIT License]: https://opensource.org/licenses/MIT
4 changes: 2 additions & 2 deletions ci/zenodo.json5
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
],

// Subset of HTML allowed here:
description: 'pywwt is the official toolkit for accessing AAS WorldWide \
description: 'pywwt is the official toolkit for accessing WorldWide \
Telescope (WWT) from Python. Learn more at <a href="https://pywwt.readthedocs.io/">the pywwt website</a>.',

access_right: 'open',
Expand All @@ -76,10 +76,10 @@ Telescope (WWT) from Python. Learn more at <a href="https://pywwt.readthedocs.io

// Keywords use an uncontrolled vocabulary (and so are of limited usefulness):
keywords: [
'AAS WorldWide Telescope',
'Astronomy',
'Python',
'Visualization',
'WorldWide Telescope',
],
},
}
28 changes: 28 additions & 0 deletions docs/api/pywwt.core.BaseWWTWidget.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ BaseWWTWidget

~BaseWWTWidget.actual_planet_scale
~BaseWWTWidget.alt_az_grid
~BaseWWTWidget.alt_az_grid_color
~BaseWWTWidget.alt_az_text
~BaseWWTWidget.available_hips_catalog_names
~BaseWWTWidget.available_layers
~BaseWWTWidget.available_views
Expand All @@ -20,18 +22,27 @@ BaseWWTWidget
~BaseWWTWidget.constellation_boundary_color
~BaseWWTWidget.constellation_figure_color
~BaseWWTWidget.constellation_figures
~BaseWWTWidget.constellation_labels
~BaseWWTWidget.constellation_pictures
~BaseWWTWidget.constellation_selection
~BaseWWTWidget.constellation_selection_color
~BaseWWTWidget.crosshairs
~BaseWWTWidget.crosshairs_color
~BaseWWTWidget.current_mode
~BaseWWTWidget.ecliptic
~BaseWWTWidget.ecliptic_color
~BaseWWTWidget.ecliptic_grid
~BaseWWTWidget.ecliptic_grid_color
~BaseWWTWidget.ecliptic_text
~BaseWWTWidget.foreground
~BaseWWTWidget.foreground_opacity
~BaseWWTWidget.galactic_grid
~BaseWWTWidget.galactic_grid_color
~BaseWWTWidget.galactic_mode
~BaseWWTWidget.galactic_text
~BaseWWTWidget.grid
~BaseWWTWidget.grid_color
~BaseWWTWidget.grid_text
~BaseWWTWidget.imagery
~BaseWWTWidget.instruments
~BaseWWTWidget.layers
Expand All @@ -40,6 +51,8 @@ BaseWWTWidget
~BaseWWTWidget.location_latitude
~BaseWWTWidget.location_longitude
~BaseWWTWidget.most_recent_source
~BaseWWTWidget.precession_chart
~BaseWWTWidget.precession_chart_color
~BaseWWTWidget.selected_sources
~BaseWWTWidget.solar_system

Expand All @@ -58,6 +71,7 @@ BaseWWTWidget
~BaseWWTWidget.get_center
~BaseWWTWidget.get_current_time
~BaseWWTWidget.get_fov
~BaseWWTWidget.get_roll
~BaseWWTWidget.load_image_collection
~BaseWWTWidget.load_tour
~BaseWWTWidget.pause_time
Expand All @@ -75,6 +89,8 @@ BaseWWTWidget

.. autoattribute:: actual_planet_scale
.. autoattribute:: alt_az_grid
.. autoattribute:: alt_az_grid_color
.. autoattribute:: alt_az_text
.. autoattribute:: available_hips_catalog_names
.. autoattribute:: available_layers
.. autoattribute:: available_views
Expand All @@ -83,18 +99,27 @@ BaseWWTWidget
.. autoattribute:: constellation_boundary_color
.. autoattribute:: constellation_figure_color
.. autoattribute:: constellation_figures
.. autoattribute:: constellation_labels
.. autoattribute:: constellation_pictures
.. autoattribute:: constellation_selection
.. autoattribute:: constellation_selection_color
.. autoattribute:: crosshairs
.. autoattribute:: crosshairs_color
.. autoattribute:: current_mode
.. autoattribute:: ecliptic
.. autoattribute:: ecliptic_color
.. autoattribute:: ecliptic_grid
.. autoattribute:: ecliptic_grid_color
.. autoattribute:: ecliptic_text
.. autoattribute:: foreground
.. autoattribute:: foreground_opacity
.. autoattribute:: galactic_grid
.. autoattribute:: galactic_grid_color
.. autoattribute:: galactic_mode
.. autoattribute:: galactic_text
.. autoattribute:: grid
.. autoattribute:: grid_color
.. autoattribute:: grid_text
.. autoattribute:: imagery
.. autoattribute:: instruments
.. autoattribute:: layers
Expand All @@ -103,6 +128,8 @@ BaseWWTWidget
.. autoattribute:: location_latitude
.. autoattribute:: location_longitude
.. autoattribute:: most_recent_source
.. autoattribute:: precession_chart
.. autoattribute:: precession_chart_color
.. autoattribute:: selected_sources
.. autoattribute:: solar_system

Expand All @@ -119,6 +146,7 @@ BaseWWTWidget
.. automethod:: get_center
.. automethod:: get_current_time
.. automethod:: get_fov
.. automethod:: get_roll
.. automethod:: load_image_collection
.. automethod:: load_tour
.. automethod:: pause_time
Expand Down
2 changes: 2 additions & 0 deletions docs/api/pywwt.layers.TableLayer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ TableLayer
~TableLayer.marker_scale
~TableLayer.marker_type
~TableLayer.opacity
~TableLayer.selectable
~TableLayer.size_att
~TableLayer.size_scale
~TableLayer.size_vmax
Expand Down Expand Up @@ -63,6 +64,7 @@ TableLayer
.. autoattribute:: marker_scale
.. autoattribute:: marker_type
.. autoattribute:: opacity
.. autoattribute:: selectable
.. autoattribute:: size_att
.. autoattribute:: size_scale
.. autoattribute:: size_vmax
Expand Down
22 changes: 0 additions & 22 deletions docs/api/pywwt.traits.AstropyQuantity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,3 @@ AstropyQuantity

.. autoclass:: AstropyQuantity
:show-inheritance:

.. rubric:: Attributes Summary

.. autosummary::

~AstropyQuantity.default_value
~AstropyQuantity.info_text

.. rubric:: Methods Summary

.. autosummary::

~AstropyQuantity.validate

.. rubric:: Attributes Documentation

.. autoattribute:: default_value
.. autoattribute:: info_text

.. rubric:: Methods Documentation

.. automethod:: validate
10 changes: 0 additions & 10 deletions docs/api/pywwt.traits.Color.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,3 @@ Color

.. autoclass:: Color
:show-inheritance:

.. rubric:: Methods Summary

.. autosummary::

~Color.validate

.. rubric:: Methods Documentation

.. automethod:: validate
10 changes: 0 additions & 10 deletions docs/api/pywwt.traits.ColorWithOpacity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,3 @@ ColorWithOpacity

.. autoclass:: ColorWithOpacity
:show-inheritance:

.. rubric:: Methods Summary

.. autosummary::

~ColorWithOpacity.validate

.. rubric:: Methods Documentation

.. automethod:: validate
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
master_doc = "index"

project = "pywwt"
author = "AAS WorldWide Telescope team, John ZuHone"
copyright = "2017-2021, " + author
author = "WorldWide Telescope Team, John ZuHone"
copyright = "2017-2023, " + author

# The short X.Y version.
from pywwt import __version__ as version
Expand Down
Binary file modified docs/images/jlab-launcher.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a402864

Please sign in to comment.