Sponsorship branding updates
This commit is contained in:
Peter Williams
Родитель
7106a7f0c3
Коммит
1492c9ba0c
101
README.md
101
README.md
|
|
@ -2,30 +2,27 @@
|
|||
[](https://doi.org/10.5281/zenodo.7164147)
|
||||
[](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/
|
||||
|
||||
|
||||
|
|
@ -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
|
||||
|
|
@ -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].
|
||||
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.
|
||||
|
||||
[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/
|
||||
[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
|
||||
|
|
|
|||
|
|
@ -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',
|
||||
|
|
@ -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',
|
||||
],
|
||||
},
|
||||
}
|
||||
|
|
|
|||
|
|
@ -19,8 +19,8 @@ source_suffix = ".rst"
|
|||
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
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
pywwt Reference Documentation
|
||||
=============================
|
||||
|
||||
pywwt is the official toolkit for accessing AAS_ `WorldWide Telescope`_ (WWT)
|
||||
from Python. WWT is a tool for showcasing astronomical data and knowledge
|
||||
brought to you by the non-profit `American Astronomical Society`_ (AAS), the
|
||||
major organization of professional astronomers in North America. To learn more
|
||||
about WWT, visit `the WWT homepage`_ or `the WWT documentation hub`_.
|
||||
The pywwt package is the official toolkit for visualizing astronomical data in
|
||||
Python using `WorldWide Telescope`_ (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. To learn more about WWT, visit `the WWT homepage`_ or `the WWT
|
||||
documentation hub`_.
|
||||
|
||||
Here's a **live, interactive** copy of the WWT research app that lets you
|
||||
explore `a 25-gigabyte mosaic of the Andromeda galaxy
|
||||
|
|
@ -13,8 +14,6 @@ explore `a 25-gigabyte mosaic of the Andromeda galaxy
|
|||
<https://panstarrs.stsci.edu/>`__ with sources from the `Gaia DR2 catalog
|
||||
<https://www.cosmos.esa.int/web/gaia/data-release-2>`__ overlaid:
|
||||
|
||||
.. _AAS: https://aas.org/
|
||||
.. _American Astronomical Society: https://aas.org/
|
||||
.. _WorldWide Telescope: https://worldwidetelescope.org/home
|
||||
.. _the WWT homepage: https://worldwidetelescope.org/home
|
||||
.. _the WWT documentation hub: https://docs.worldwidetelescope.org/
|
||||
|
|
@ -111,11 +110,10 @@ discussion forum`_ site.
|
|||
Acknowledgments
|
||||
---------------
|
||||
|
||||
pywwt is part of the AAS WorldWide Telescope system, a `.NET Foundation`_
|
||||
project managed by the non-profit `American Astronomical Society`_ (AAS). Work
|
||||
on WWT has been supported by the AAS, the US `National Science Foundation`_, and
|
||||
other partners. See `the WWT user website`_ for details.
|
||||
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`_ for details.
|
||||
|
||||
.. _American Astronomical Society: https://aas.org/
|
||||
.. _.NET Foundation: https://dotnetfoundation.org/
|
||||
.. _National Science Foundation: https://www.nsf.gov/
|
||||
.. _the WWT user website: https://worldwidetelescope.org/about/acknowledgments/
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ that everything is set up:
|
|||
jupyter lab build
|
||||
|
||||
If the installation is successful, then the next time you start up JupyterLab
|
||||
the “Launcher” display should now contain an AAS WorldWide Telescope icon:
|
||||
the “Launcher” display should now contain a WorldWide Telescope icon:
|
||||
|
||||
.. image:: images/jlab-launcher.jpg
|
||||
:scale: 50%
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ This will then look like:
|
|||
|
||||
.. image:: images/jupyter.jpg
|
||||
|
||||
Once the AAS WorldWide Telescope widget is visible, you can start to interact
|
||||
Once the WorldWide Telescope widget is visible, you can start to interact
|
||||
with the ``wwt`` object in the next cell of the notebook. You can find out more
|
||||
about interacting with this object in :doc:`settings` and :doc:`annotations`.
|
||||
See also the API documentation of the :class:`~pywwt.jupyter.WWTJupyterWidget`
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ built. `Learn how to set up pywwt's JupyerLab integration JupyterLab here
|
|||
<installation>`_.
|
||||
|
||||
Once the ingration is set up, then the next time you start up JupyterLab the
|
||||
“Launcher” display should now contain an AAS WorldWide Telescope icon:
|
||||
“Launcher” display should now contain a WorldWide Telescope icon:
|
||||
|
||||
.. image:: images/jlab-launcher.jpg
|
||||
:scale: 50%
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ To use the WWT Qt viewer from an IPython session, do::
|
|||
In [3]: wwt = WWTQtClient()
|
||||
|
||||
Note that the order is important — for now :class:`pywwt.qt.WWTQtClient` has to
|
||||
be imported before ``%gui qt`` is run. Once the AAS WorldWide Telescope viewer is
|
||||
be imported before ``%gui qt`` is run. Once the WorldWide Telescope viewer is
|
||||
visible, you can start to interact with the ``wwt`` object in the next cell of
|
||||
the notebook. You can find out more about interacting with this object in
|
||||
:doc:`settings` and :doc:`annotations`.
|
||||
|
|
@ -37,7 +37,7 @@ not necessary::
|
|||
wwt = WWTQtClient()
|
||||
|
||||
The :class:`pywwt.qt.WWTQtClient` class takes a ``block_until_ready`` argument
|
||||
which can be used to tell Python to wait for AAS WorldWide Telescope to be open
|
||||
which can be used to tell Python to wait for WorldWide Telescope to be open
|
||||
before proceeding with the rest of the script::
|
||||
|
||||
wwt = WWTQtClient(block_until_ready=True)
|
||||
|
|
@ -55,7 +55,7 @@ closed. You can find out more about interacting with the ``wwt`` object in
|
|||
Embedding
|
||||
---------
|
||||
|
||||
If you are developing a Qt Application, you can embed the AAS WorldWide Telescope
|
||||
If you are developing a Qt Application, you can embed the WorldWide Telescope
|
||||
Qt widget by creating an instance of the :class:`pywwt.qt.WWTQtClient` class,
|
||||
then accessing the underlying Qt widget using the ``widget`` attribute::
|
||||
|
||||
|
|
|
|||
|
|
@ -2,12 +2,12 @@ Basic controls
|
|||
==============
|
||||
|
||||
Once a Jupyter or Qt widget has been created, the way in which you change
|
||||
settings and interact with AAS WorldWide Telescope is the same.
|
||||
settings and interact with WorldWide Telescope is the same.
|
||||
|
||||
Visual settings
|
||||
---------------
|
||||
|
||||
Once the AAS WorldWide Telescope Jupyter or Qt widget has been initialized -- here
|
||||
Once the WorldWide Telescope Jupyter or Qt widget has been initialized -- here
|
||||
we assign it to the variable name ``wwt`` -- you can toggle several visual
|
||||
settings on and off. For example::
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Changing and controlling views
|
|||
==============================
|
||||
|
||||
PyWWT includes the option to toggle between view modes in the same manner as in
|
||||
the AAS WorldWide Telescope Web Client by using the
|
||||
the WorldWide Telescope Web Client by using the
|
||||
:meth:`~pywwt.BaseWWTWidget.set_view` method. Available modes include a view of
|
||||
the sky, as well as 3D views of celestial bodies, the solar system, the galaxy,
|
||||
or the observable universe. The rest of the documentation is based on the
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Connecting to the WWT Windows application
|
|||
About
|
||||
-----
|
||||
|
||||
The :mod:`pywwt.windows` sub-package includes a Python interface for the AAS
|
||||
The :mod:`pywwt.windows` sub-package includes a Python interface for the
|
||||
`WorldWide Telescope <http://www.worldwidetelescope.org/home>`_
|
||||
(WWT) Windows client, using the
|
||||
`Layer Control API (LCAPI) <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#load>`_.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ detail.
|
|||
[pywwt]: https://pywwt.readthedocs.io/
|
||||
[Jupyter Widget]: https://ipywidgets.readthedocs.io/
|
||||
|
||||
To use the [AAS][aas] [WorldWide Telescope][wwt] (WWT) technology inside the
|
||||
To use the [WorldWide Telescope][wwt] (WWT) technology inside the
|
||||
[JupyterLab] computational environment (NB: JupyterLab is distinct from
|
||||
“vanilla” Jupyter), we recommend that you skip this widget and instead use the
|
||||
[wwt-jupyterlab] extension. The dedicated extension installs the more powerful
|
||||
|
|
@ -15,7 +15,6 @@ WWT “[research app]” into your JupyterLab environment. That being said, this
|
|||
package also includes a small JupyterLab extension that makes the pywwt widget
|
||||
available within the JupyterLab context, if that’s what you want to use.
|
||||
|
||||
[aas]: https://aas.org/
|
||||
[wwt]: https://worldwidetelescope.org/home
|
||||
[JupyterLab]: https://jupyterlab.readthedocs.io/
|
||||
[wwt-jupyterlab]: https://github.com/WorldWideTelescope/wwt-jupyterlab/
|
||||
|
|
@ -26,11 +25,14 @@ stack][web-docs].
|
|||
|
||||
[web-docs]: https://docs.worldwidetelescope.org/webgl-reference/latest/
|
||||
|
||||
WWT is a free, open-source tool for visually exploring humanity’s scientific
|
||||
understanding of the Universe. 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].
|
||||
The WorldWide Telescope project is fiscally sponsored by
|
||||
[NumFOCUS](https://numfocus.org/). Consider making a [tax-deductible
|
||||
donation](https://numfocus.org/donate-for-worldwide-telescope) to help support
|
||||
the project. Work on WWT has been supported by the [American Astronomical
|
||||
Society] (AAS), the [.NET Foundation], and other organizational partners. See
|
||||
[the WWT user website][acks] for details.
|
||||
|
||||
[pywwt]: https://pywwt.readthedocs.io/
|
||||
[dnf]: https://dotnetfoundation.org/
|
||||
[American Astronomical Society]: https://aas.org/
|
||||
[.NET Foundation]: https://dotnetfoundation.org/
|
||||
[acks]: https://worldwidetelescope.org/about/acknowledgments/
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
"@wwtelescope/research-app": "^0.15.0",
|
||||
"underscore": "^1"
|
||||
},
|
||||
"description": "AAS WorldWide Telescope from Python",
|
||||
"description": "WorldWide Telescope from Python",
|
||||
"devDependencies": {
|
||||
"shelljs": "^0.8",
|
||||
"shx": "^0.3",
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ dom_listener = DOMListener()
|
|||
@widgets.register
|
||||
class WWTJupyterWidget(widgets.DOMWidget, BaseWWTWidget):
|
||||
"""
|
||||
An AAS WorldWide Telescope Jupyter widget.
|
||||
A WorldWide Telescope (WWT) Jupyter widget.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
|
@ -341,9 +341,9 @@ def connect_to_app():
|
|||
Connect to a WWT application running inside a JupyterLab computational
|
||||
environment. This is your preferred gateway to using WWT in JupyterLab.
|
||||
|
||||
For the time being, you must have opened the AAS WorldWide Telescope app
|
||||
For the time being, you must have opened the WorldWide Telescope app
|
||||
inside JupyterLab. You can do this by clicking the large WWT icon in the
|
||||
JupyterLab launcher, or by invoking the "AAS WorldWide Telescope" command.
|
||||
JupyterLab launcher, or by invoking the "WorldWide Telescope" command.
|
||||
You can open the JupyterLab command palette by typing
|
||||
Control/Command-Shift-C.
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче