forked from spacetelescope/toasty
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
+++ cranko-release-info-v1 [[projects]] qnames = ["toasty", "pypa"] version = "0.17.0" age = 0 +++
- Loading branch information
Showing
17 changed files
with
501 additions
and
183 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
.. _cli-tile-healpix: | ||
|
||
======================= | ||
``toasty tile-healpix`` | ||
======================= | ||
|
||
The ``tile-healpix`` command transforms all-sky FITS images in the HEALPix_ | ||
format into WWT’s FITS TOAST format. | ||
|
||
.. _HEALPix: https://healpix.jpl.nasa.gov/ | ||
|
||
Usage | ||
===== | ||
|
||
.. code-block:: shell | ||
toasty tile-healpix | ||
[--galactic] | ||
[--outdir DIR] | ||
[--parallelism FACTOR] [-j FACTOR] | ||
{FITS-PATH} | ||
{TOAST-DEPTH} | ||
The ``FITS-PATH`` argument gives the filename of the input image, which should | ||
be a single FITS file storing data in the HEALPix_ format. | ||
|
||
The ``TOAST-DEPTH`` argument specifies the resolution level of the TOAST | ||
pixelization that will be generated. A depth of 0 means that the input will be | ||
sampled onto a single 256×256 tile, a depth of 1 means that the input will be | ||
sampled onto four tiles for a total resolution of 512×512, and so on. When | ||
converting from HEALPix, the appropriate TOAST depth can be derived from the | ||
HEALPix ``N_side`` parameter as approximately:: | ||
|
||
depth = log2(N_side) - 6.2 | ||
|
||
One should typically round up to the next larger integer to err on the side of | ||
higher resolution, although the best policy will depend on the sampling of the | ||
input HEALPix map. | ||
|
||
The ``--outdir DIR`` option specifies where the output data should be written. | ||
If unspecified, the data root will be the current directory. | ||
|
||
The ``--galactic`` option forces the tiling to assume that the input map is in | ||
Galactic coordinates, even if the FITS headers do not specify that. This has | ||
been observed in some data sets in the wild. | ||
|
||
The ``--parallelism FACTOR`` argument (or ``-j FACTOR``) specifies the level of | ||
parallism to use. On operating systems that support parallel processing, the | ||
default is to use all CPUs. To disable parallel processing, explicitly specify a | ||
factor of 1. | ||
|
||
Notes | ||
===== | ||
|
||
This command requires that the healpy_ Python module is installed. | ||
|
||
.. _healpy: https://healpy.readthedocs.io/ | ||
|
||
This command will create FITS files for the highest-resolution tile layer, | ||
corresponding to the ``DEPTH`` argument, and emit an ``index_rel.wtml`` file | ||
containing projection information and template metadata. | ||
|
||
The WWT rendering engine can also display datasets in the hierarchical HiPS_ | ||
FITS format, which addresses about the same use case as TOAST. If a HiPS FITS | ||
dataset already exists, it is probably a wiser choice to use it rather than | ||
creating a new TOAST pyramid. However, TOAST provides noticeably better | ||
performance for the initial data display and avoiding positional shifts as the | ||
user zooms in. | ||
|
||
.. _HiPS: https://aladin.unistra.fr/hips/ | ||
|
||
Currently, parallel processing is only supported on the Linux operating system, | ||
because ``fork()``-based multiprocessing is required. MacOS should support this, | ||
but there is currently (as of Python 3.8) `a bug`_ preventing that. | ||
|
||
.. _a bug: https://bugs.python.org/issue33725 | ||
|
||
|
||
See Also | ||
======== | ||
|
||
- :ref:`cli-tile-allsky` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,78 +1,63 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
project = 'toasty' | ||
author = 'Chris Beaumont and the AAS WorldWide Telescope Team' | ||
copyright = '2014-2020, ' + author | ||
project = "toasty" | ||
author = "Chris Beaumont and the AAS WorldWide Telescope Team" | ||
copyright = "2014-2020, " + author | ||
|
||
release = '0.dev0' # cranko project-version | ||
version = '.'.join(release.split('.')[:2]) | ||
release = "0.dev0" # cranko project-version | ||
version = ".".join(release.split(".")[:2]) | ||
|
||
extensions = [ | ||
'sphinx.ext.autodoc', | ||
'sphinx.ext.doctest', | ||
'sphinx.ext.intersphinx', | ||
'sphinx.ext.mathjax', | ||
'sphinx.ext.viewcode', | ||
'sphinx_automodapi.automodapi', | ||
'sphinx_automodapi.smart_resolver', | ||
'numpydoc', | ||
"sphinx.ext.autodoc", | ||
"sphinx.ext.doctest", | ||
"sphinx.ext.intersphinx", | ||
"sphinx.ext.mathjax", | ||
"sphinx.ext.viewcode", | ||
"sphinx_automodapi.automodapi", | ||
"sphinx_automodapi.smart_resolver", | ||
"numpydoc", | ||
] | ||
|
||
templates_path = ['_templates'] | ||
source_suffix = '.rst' | ||
master_doc = 'index' | ||
language = None | ||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
pygments_style = 'sphinx' | ||
templates_path = ["_templates"] | ||
source_suffix = ".rst" | ||
master_doc = "index" | ||
language = "en" | ||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] | ||
pygments_style = "sphinx" | ||
todo_include_todos = False | ||
|
||
html_theme = 'bootstrap-astropy' | ||
html_theme = "bootstrap-astropy" | ||
html_theme_options = { | ||
'logotext1': 'toasty', | ||
'logotext2': '', | ||
'logotext3': ':docs', | ||
'astropy_project_menubar': False, | ||
"logotext1": "toasty", | ||
"logotext2": "", | ||
"logotext3": ":docs", | ||
"astropy_project_menubar": False, | ||
} | ||
html_static_path = ['_static'] | ||
htmlhelp_basename = 'toastydoc' | ||
html_static_path = ["_static"] | ||
htmlhelp_basename = "toastydoc" | ||
|
||
intersphinx_mapping = { | ||
'python': ( | ||
'https://docs.python.org/3/', | ||
(None, 'http://data.astropy.org/intersphinx/python3.inv') | ||
"python": ( | ||
"https://docs.python.org/3/", | ||
(None, "http://data.astropy.org/intersphinx/python3.inv"), | ||
), | ||
|
||
'astropy': ( | ||
'https://docs.astropy.org/en/stable/', | ||
None | ||
), | ||
|
||
'numpy': ( | ||
'https://numpy.org/doc/stable/', | ||
(None, 'http://data.astropy.org/intersphinx/numpy.inv') | ||
), | ||
|
||
'PIL': ( | ||
'https://pillow.readthedocs.io/en/stable/', | ||
None | ||
), | ||
|
||
'wwt_data_formats': ( | ||
'https://wwt-data-formats.readthedocs.io/en/stable/', | ||
None | ||
"astropy": ("https://docs.astropy.org/en/stable/", None), | ||
"numpy": ( | ||
"https://numpy.org/doc/stable/", | ||
(None, "http://data.astropy.org/intersphinx/numpy.inv"), | ||
), | ||
"PIL": ("https://pillow.readthedocs.io/en/stable/", None), | ||
"wwt_data_formats": ("https://wwt-data-formats.readthedocs.io/en/stable/", None), | ||
} | ||
|
||
numpydoc_show_class_members = False | ||
|
||
nitpicky = True | ||
nitpick_ignore = [ | ||
('py:class', 'ipywidgets.widgets.domwidget.DOMWidget') | ||
] | ||
nitpick_ignore = [("py:class", "ipywidgets.widgets.domwidget.DOMWidget")] | ||
|
||
default_role = 'obj' | ||
default_role = "obj" | ||
|
||
html_logo = 'images/logo.png' | ||
html_logo = "images/logo.png" | ||
|
||
linkcheck_retries = 5 | ||
linkcheck_timeout = 10 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.