docs: update links to satisfying the linkcheck
This commit is contained in:
Родитель
8829dbde76
Коммит
ea25a00a7a
12
docs/conf.py
12
docs/conf.py
|
@ -183,16 +183,16 @@ intersphinx_mapping = {
|
|||
'python': ('https://docs.python.org/3/',
|
||||
(None, 'http://data.astropy.org/intersphinx/python3.inv')),
|
||||
'numpy': ('https://docs.scipy.org/doc/numpy/',
|
||||
(None, 'http://data.astropy.org/intersphinx/numpy.inv')),
|
||||
(None, 'https://numpy.org/doc/stable/objects.inv')),
|
||||
'scipy': ('https://docs.scipy.org/doc/scipy/reference/',
|
||||
(None, 'http://data.astropy.org/intersphinx/scipy.inv')),
|
||||
'traitlets': ('http://traitlets.readthedocs.io/en/latest/',
|
||||
(None, 'http://traitlets.readthedocs.io/en/latest/objects.inv')),
|
||||
'traitlets': ('https://traitlets.readthedocs.io/en/latest/',
|
||||
(None, 'https://traitlets.readthedocs.io/en/latest/objects.inv')),
|
||||
# 'ipywidgets': ('http://ipywidgets.readthedocs.io/en/latest/',
|
||||
# (None, 'http://ipywidgets.readthedocs.io/en/latest/objects.inv')),
|
||||
'matplotlib': ('http://matplotlib.org/',
|
||||
(None, 'http://data.astropy.org/intersphinx/matplotlib.inv')),
|
||||
'astropy': ('http://docs.astropy.org/en/stable/', None)}
|
||||
'matplotlib': ('https://matplotlib.org/',
|
||||
(None, 'https://matplotlib.org/objects.inv')),
|
||||
'astropy': ('https://docs.astropy.org/en/stable/', None)}
|
||||
|
||||
numpydoc_show_class_members = False
|
||||
|
||||
|
|
|
@ -47,7 +47,7 @@ can do straight in your browser with our cloud-based Jupyter notebooks. Here
|
|||
are some examples:
|
||||
|
||||
* `Visualize Tabular Data from the NASA Exoplanet Archive
|
||||
<http://binder.wwt-forum.org/v2/gh/WorldWideTelescope/pywwt-notebooks/master?urlpath=lab/tree/NASA%20Exoplanet%Archive.ipynb>`__
|
||||
<http://binder.wwt-forum.org/v2/gh/WorldWideTelescope/pywwt-notebooks/master?urlpath=lab/tree/NASA%20Exoplanet%20Archive.ipynb>`__
|
||||
* `Visualize Imagery of W5 and SN2011fe
|
||||
<http://binder.wwt-forum.org/v2/gh/WorldWideTelescope/pywwt-notebooks/master?urlpath=lab/tree/Visualizing%20Imagery.ipynb>`__
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@ pywwt-notebooks repository`_ on GitHub for quick links to the latest examples.
|
|||
Installing pywwt with conda (recommended)
|
||||
-----------------------------------------
|
||||
|
||||
If you use the `Anaconda Distribution <https://www.anaconda.com/distribution/#macos>`_
|
||||
If you use the `Anaconda Distribution <https://www.anaconda.com/products/individual>`_
|
||||
(or `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_), you can install the latest
|
||||
release of pywwt using::
|
||||
|
||||
|
@ -61,7 +61,7 @@ dependencies will get installed automatically (with the exception of PyQt/PySide
|
|||
if using pip). For the record, these dependencies are as follows:
|
||||
|
||||
* `Python <https://www.python.org>`_ 3.6 or later
|
||||
* `NumPy <https://www.numpy.org>`_ 1.9 or later
|
||||
* `NumPy <https://numpy.org>`_ 1.9 or later
|
||||
* `Matplotlib <https://matplotlib.org>`_ 1.5 or later
|
||||
* `Astropy <https://www.astropy.org>`_ 1.0 or later
|
||||
* `Requests <https://requests.kennethreitz.org/en/master/>`_
|
||||
|
@ -72,7 +72,7 @@ if using pip). For the record, these dependencies are as follows:
|
|||
* `ipyevents <https://github.com/mwcraig/ipyevents>`_
|
||||
* `traitlets <https://traitlets.readthedocs.io>`_
|
||||
* `reproject <https://reproject.readthedocs.io/>`_
|
||||
* `pytz <http://pythonhosted.org/pytz>`_
|
||||
* `pytz <https://pythonhosted.org/pytz>`_
|
||||
|
||||
In addition, if you want to use the Qt widget, you will need:
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@ used to show image-based data on the celestial sphere.
|
|||
|
||||
The main layer type for point-data at the moment is
|
||||
:class:`~pywwt.layers.TableLayer`. This layer type can be created using an
|
||||
`astropy <http://docs.astropy.org/en/stable/table/index.html>`__
|
||||
`astropy <https://docs.astropy.org/en/stable/table/index.html>`__
|
||||
:class:`~astropy.table.Table` as well as a coordinate frame, which can be e.g.
|
||||
``'Sky'`` or the name of one of the planets or satellites. The main layer type
|
||||
for images is :class:`~pywwt.layers.ImageLayer`.
|
||||
|
@ -24,7 +24,7 @@ Loading point data
|
|||
To start off, let's look at how to show a simple set positions on the sky. We'll
|
||||
use the `Open Exoplanet Catalogue <http://openexoplanetcatalogue.com>`_ as a
|
||||
first example. We start off by using `astropy.table
|
||||
<http://docs.astropy.org/en/stable/table/index.html>`_ to read in a
|
||||
<https://docs.astropy.org/en/stable/table/index.html>`_ to read in a
|
||||
comma-separated values (CSV) file of the data::
|
||||
|
||||
>>> from astropy.table import Table
|
||||
|
@ -135,7 +135,7 @@ the time series attribute and specifying the proper column::
|
|||
>>> layer.time_att = 'time'
|
||||
|
||||
(Please note that time columns must contain
|
||||
`astropy <http://docs.astropy.org/en/stable/time/index.html>`__
|
||||
`astropy <https://docs.astropy.org/en/stable/time/index.html>`__
|
||||
:class:`~astropy.time.Time` objects, :class:`~datetime.datetime` objects, or
|
||||
`ISOT
|
||||
<https://docs.astropy.org/en/stable/api/astropy.time.TimeISOT.html#astropy.time.
|
||||
|
|
|
@ -58,7 +58,7 @@ region of the sky, given a certain set of coordinates in the form of an astropy
|
|||
:class:`~astropy.coordinates.SkyCoord` object and a field of view (zoom level in
|
||||
astropy pixel units) for the viewer. You can read more about creating
|
||||
:class:`~astropy.coordinates.SkyCoord` objects `here
|
||||
<http://docs.astropy.org/en/stable/coordinates/index.html>`_. One of the useful
|
||||
<https://docs.astropy.org/en/stable/coordinates/index.html>`_. One of the useful
|
||||
features of this class is the ability to create coordinates based on an object
|
||||
name, so we can use this here to center on a particular object::
|
||||
|
||||
|
|
|
@ -127,7 +127,7 @@ a factor of 10000, use::
|
|||
It is also possible to specify a time in the viewer yourself through the
|
||||
:meth:`~pywwt.BaseWWTWidget.set_current_time` method as long as the time
|
||||
provided is a :class:`~datetime.datetime` or an
|
||||
`astropy <http://docs.astropy.org/en/stable/time/index.html>`_
|
||||
`astropy <https://docs.astropy.org/en/stable/time/index.html>`_
|
||||
:class:`~astropy.time.Time` object::
|
||||
|
||||
>>> from astropy.time import Time
|
||||
|
|
|
@ -7,7 +7,7 @@ About
|
|||
The **pywwt.windows** sub-package includes a Python interface for the AAS
|
||||
`WorldWide Telescope <http://www.worldwidetelescope.org/home>`_
|
||||
(WWT) Windows client, using the
|
||||
`Layer Control API (LCAPI) <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#load>`_.
|
||||
`Layer Control API (LCAPI) <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#load>`_.
|
||||
The LCAPI provides an interface to WWT's Layer Manager by sending data and
|
||||
information in the form of strings over HTTP. ``pywwt`` simply provides a Python
|
||||
interface to make these calls, enabling the control of WWT from scripts or an
|
||||
|
@ -91,7 +91,7 @@ tabs. The second two arguments are the ``frame`` to load the data into, and the
|
|||
``name`` for the new layer. In addition to CSV files, the
|
||||
:meth:`~pywwt.windows.WWTWindowsClient.load` command shape files (.shp), 3D
|
||||
model files (.3ds), and `WTML files containing ImageSet references
|
||||
<http://www.worldwidetelescope.org/Docs/WorldWideTelescopeDataFilesReference.html>`_.
|
||||
<https://docs.worldwidetelescope.org/data-guide/1/data-file-formats/collections/>`_.
|
||||
|
||||
:meth:`~pywwt.windows.WWTWindowsClient.load` takes a number of keyword
|
||||
arguments, which may be used to customize the data in the layer. These include
|
||||
|
@ -105,7 +105,7 @@ to control the fading in and out of data::
|
|||
:meth:`~pywwt.windows.WWTWindowsClient.load` returns a
|
||||
:class:`~pywwt.windows.WWTLayer` instance.
|
||||
|
||||
`LCAPI Reference: Load <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#load>`_
|
||||
`LCAPI Reference: Load <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#load>`_
|
||||
|
||||
new_layer
|
||||
+++++++++
|
||||
|
@ -123,7 +123,7 @@ the names of the data arrays that will be loaded into the
|
|||
:meth:`~pywwt.windows.WWTWindowsClient.new_layer` also takes the same keyword
|
||||
arguments as :meth:`~pywwt.windows.WWTWindowsClient.load`.
|
||||
|
||||
`LCAPI Reference: New <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#new>`_
|
||||
`LCAPI Reference: New <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#new>`_
|
||||
|
||||
new_layer_group
|
||||
+++++++++++++++
|
||||
|
@ -138,7 +138,7 @@ that are sub-sets of other groups::
|
|||
The first argument is the reference ``frame`` for the group and the second is
|
||||
the ``name`` of the group.
|
||||
|
||||
`LCAPI Reference: Group <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#group>`_
|
||||
`LCAPI Reference: Group <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#group>`_
|
||||
|
||||
get_existing_layer
|
||||
++++++++++++++++++
|
||||
|
@ -177,7 +177,7 @@ be cleared from the layer. Setting ``no_purge`` to `True` will prevent data
|
|||
that has already occurred from being deleted from the layer, which would happen
|
||||
by default. ``show`` controls whether the layer is shown or hidden.
|
||||
|
||||
`LCAPI Reference: Update <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#update>`_
|
||||
`LCAPI Reference: Update <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#update>`_
|
||||
|
||||
activate
|
||||
++++++++
|
||||
|
@ -187,11 +187,11 @@ layer in the layer manager::
|
|||
|
||||
layer.activate()
|
||||
|
||||
`LCAPI Reference: Activate <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#activate>`_
|
||||
`LCAPI Reference: Activate <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#activate>`_
|
||||
|
||||
There are a number of properties associated with each layer, and there are
|
||||
methods for getting and setting these properties. There is a `list of properties
|
||||
<https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#table-of-properties>`_
|
||||
<https://docs.worldwidetelescope.org/lcapi-guide/1/properties/>`_
|
||||
for layers at the WWT website.
|
||||
|
||||
get_property
|
||||
|
@ -202,7 +202,7 @@ given its ``property_name``::
|
|||
|
||||
prop = layer.get_property("CoordinatesType")
|
||||
|
||||
`LCAPI Reference: Getprop <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#getprop>`_
|
||||
`LCAPI Reference: Getprop <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#getprop>`_
|
||||
|
||||
get_properties
|
||||
++++++++++++++
|
||||
|
@ -212,7 +212,7 @@ a layer in a Python dict::
|
|||
|
||||
prop_dict = layer.get_properties()
|
||||
|
||||
`LCAPI Reference: Getprops <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#getprops>`_
|
||||
`LCAPI Reference: Getprops <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#getprops>`_
|
||||
|
||||
set_property
|
||||
++++++++++++
|
||||
|
@ -224,7 +224,7 @@ set_property
|
|||
|
||||
The ``property_name`` and ``property_value`` must both be strings.
|
||||
|
||||
`LCAPI Reference: Setprop <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#setprop>`_
|
||||
`LCAPI Reference: Setprop <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#setprop>`_
|
||||
|
||||
set_properties
|
||||
++++++++++++++
|
||||
|
@ -245,7 +245,7 @@ pairs::
|
|||
|
||||
Each name and value must be a string.
|
||||
|
||||
`LCAPI Reference: Setprops <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#setprops>`_
|
||||
`LCAPI Reference: Setprops <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#setprops>`_
|
||||
|
||||
delete
|
||||
++++++
|
||||
|
@ -260,7 +260,7 @@ message::
|
|||
|
||||
WWTException: This layer has been deleted!
|
||||
|
||||
`LCAPI Reference: Delete <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#delete>`_
|
||||
`LCAPI Reference: Delete <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#delete>`_
|
||||
|
||||
Other Commands
|
||||
~~~~~~~~~~~~~~
|
||||
|
@ -276,7 +276,7 @@ Earth, Planet, Sky, Panorama, SolarSystem::
|
|||
|
||||
wwt.change_mode("SolarSystem")
|
||||
|
||||
`LCAPI Reference: Mode <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#mode>`_
|
||||
`LCAPI Reference: Mode <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#mode>`_
|
||||
|
||||
get_frame_list
|
||||
++++++++++++++
|
||||
|
@ -298,7 +298,7 @@ returns something like::
|
|||
'Venus': {'Enabled': 'True'},
|
||||
'Ymir': {'Enabled': 'True'}}
|
||||
|
||||
`LCAPI Reference: LayerList <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#layerlist>`_
|
||||
`LCAPI Reference: LayerList <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#layerlist>`_
|
||||
|
||||
get_layer_list
|
||||
++++++++++++++
|
||||
|
@ -327,7 +327,7 @@ returns something like::
|
|||
'Type': 'SkyOverlays',
|
||||
'Version': '2'}}
|
||||
|
||||
`LCAPI Reference: LayerList <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#layerlist>`_
|
||||
`LCAPI Reference: LayerList <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#layerlist>`_
|
||||
|
||||
get_state
|
||||
+++++++++
|
||||
|
@ -351,7 +351,7 @@ returns something along the lines of::
|
|||
'timerate': '1',
|
||||
'zoom': '600000000000'}
|
||||
|
||||
`LCAPI Reference: State <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#state>`_
|
||||
`LCAPI Reference: State <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#state>`_
|
||||
|
||||
move_view
|
||||
+++++++++
|
||||
|
@ -375,7 +375,7 @@ where the parameter may be one of:
|
|||
- ``"TiltDown"``: Angle the view down 0.2 of one radian.
|
||||
- ``"Finder"``: Currently unimplemented.
|
||||
|
||||
`LCAPI Reference: Move <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#move>`_
|
||||
`LCAPI Reference: Move <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#move>`_
|
||||
|
||||
ui_settings
|
||||
+++++++++++
|
||||
|
@ -388,7 +388,7 @@ settings without altering the layer data::
|
|||
wwt.ui_settings("ShowConstellationBoundries", "True")
|
||||
|
||||
To see the list of possible settings see the `LCAPI section on uisettings
|
||||
<https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#uisettings>`_.
|
||||
<https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#uisettings>`_.
|
||||
|
||||
Standard Keyword Arguments
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
@ -429,7 +429,7 @@ which would rotate the view clockwise, set the current date and time to 1/1/2000
|
|||
at 12:00:00 AM UTC, and increase the rate of the passage of time by a factor of
|
||||
100.
|
||||
|
||||
`LCAPI Reference: General Parameters <https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#general-parameters>`_
|
||||
`LCAPI Reference: General Parameters <https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#general-parameters>`_
|
||||
|
||||
Data Utilities
|
||||
~~~~~~~~~~~~~~
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"First, we'll import the `WWTWindowsClient` class, as well as [numpy](http://www.numpy.org) and [h5py](http://www.h5py.org), which we'll need for this example. We will also import [astropy.units](http://docs.astropy.org/en/stable/units/index.html) to handle unit conversions"
|
||||
"First, we'll import the `WWTWindowsClient` class, as well as [numpy](http://www.numpy.org) and [h5py](http://www.h5py.org), which we'll need for this example. We will also import [astropy.units](https://docs.astropy.org/en/stable/units/index.html) to handle unit conversions"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
@ -201,4 +201,4 @@
|
|||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 1
|
||||
}
|
||||
}
|
|
@ -69,7 +69,7 @@ class WWTWindowsClient(object):
|
|||
Changes the view depending on the supplied parameter.
|
||||
For a list of parameters see:
|
||||
|
||||
https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#move
|
||||
https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#move
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
@ -267,7 +267,7 @@ class WWTWindowsClient(object):
|
|||
Change user interface settings, without altering the
|
||||
layer data. For the settings list see:
|
||||
|
||||
https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#uisettings
|
||||
https://docs.worldwidetelescope.org/lcapi-guide/1/lcapicommands/#uisettings
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
|
|
@ -35,7 +35,7 @@ class WWTLayer(object):
|
|||
"""
|
||||
Set a single property. For a list of properties see:
|
||||
|
||||
https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#table-of-properties
|
||||
https://docs.worldwidetelescope.org/lcapi-guide/1/properties/
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
@ -62,7 +62,7 @@ class WWTLayer(object):
|
|||
Set the properties of the layer. For a list of properties
|
||||
see:
|
||||
|
||||
https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#table-of-properties
|
||||
https://docs.worldwidetelescope.org/lcapi-guide/1/properties/
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
@ -88,7 +88,7 @@ class WWTLayer(object):
|
|||
"""
|
||||
Return a property. For a list of properties see:
|
||||
|
||||
https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#table-of-properties
|
||||
https://docs.worldwidetelescope.org/lcapi-guide/1/properties/
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
@ -109,7 +109,7 @@ class WWTLayer(object):
|
|||
Return all the properties of the layer. For a list of properties
|
||||
see:
|
||||
|
||||
https://worldwidetelescope.gitbook.io/layer-control-reference/lcapicommands#table-of-properties
|
||||
https://docs.worldwidetelescope.org/lcapi-guide/1/properties/
|
||||
|
||||
Returns
|
||||
-------
|
||||
|
|
Загрузка…
Ссылка в новой задаче