Metadata-Version: 2.4
Name: skyproj
Version: 2.3.0
Summary: Python tools for making sky projections and maps
Author: Alex Drlica-Wagner, others
Author-email: Eli Rykoff <erykoff@stanford.edu>
License: BSD 3-Clause License
        
        Copyright (c) 2022, erykoff
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: home, https://github.com/lsstdesc/skyproj
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy>=4.0
Requires-Dist: matplotlib>=3.8
Requires-Dist: hpgeom
Requires-Dist: healsparse
Requires-Dist: numpy
Dynamic: license-file

# skyproj: Sky Projections with matplotlib and proj

The `skyproj` package provides an astronomically oriented interface to ploting sky maps based on [`matplotlib`](https://matplotlib.org/) and [PROJ](https://proj.org/).
This package addresses several issues present in the [`healpy`](https://healpy.readthedocs.io/en/latest/) plotting routines:
1. `healpy` supports a limited set of sky projections (`cartview`, `mollview`, and `gnomview`)
2. `healpy` converts sparse healpix maps to full maps to plot; this is memory intensive for large `nside`

`skyproj` is intended as the primary visualization tool for [`healsparse`](https://healsparse.readthedocs.io/en/latest/) maps, which provide high resolution maps in a memory efficent way.
`skyproj` can create interactive visualizations of `healsparse` and `healpy` maps that dynamically change resolution.
In addition, `skyproj` provides some convenience functionality for large optical surveys.
The `skyproj` package has its origins in `cartosky`, which was built on `cartopy` and some of the features may be familiar to users of `cartopy`.
However, it has diverged significantly from the original code as the needs of mapping the sky are somewhat different than the needs of mapping the Earth.

## Installation

The easiest way to install `skyproj` is from pypi or conda-forge. (Coming soon.)

## Tutorial

If you want to see what you can do with `skyproj`, check out the [tutorial](tutorial/).
