Skip to main content

A CL-Util to download stacked and/or warp image stamps from the STScI PanSTARRS image server

Project description

panstamps

A CL-Util to download stacked and/or warp image stamps from the STScI PanSTARRS image server.

Usage

panstamps [options] [–width=<arcminWidth>] [–filters=<filterSet>] [–settings=<pathToSettingsFile>] [–downloadFolder=<path>] (warp|stack) <ra> <dec>

-h, --help

show this help message

-f, --fits

download fits (default on)

-F, --nofits

don’t download fits (default off)

-j, --jpeg

download jepg (default off)

-J, --nojpeg

don’t download jepg (default on)

-c, --color

download color jepg (default off)

-C, --nocolor

don’t download color jepg (default on)

-a, --annotate

annotate jpeg (default true)

-A, --noannotate

don’t annotate jpeg (default false)

-t, --transient

add a small red circle at transient location (default false)

-T, --notransient

don’t add a small red circle at transient location (default true)

-g, --greyscale

convert jpeg to greyscale (default false)

-G, --nogreyscale

don’t convert jpeg to greyscale (default true)

-i, --invert

invert jpeg colors (default false)

-I, --noinvert

don’t invert jpeg colors (default true)

--width=<arcminWidth>

width of image in arcsec (default 1)

--filters=<filterSet>

filter set to download and use for color image (default gri)

--downloadFolder=<path>

path to the download folder, relative or absolute (folder created where command is run if not set)

--settings=<pathToSettingsFile>

the settings file

Documentation

Documentation for panstamps is hosted by [Read the Docs](http://panstamps.readthedocs.org/en/stable/) (last [stable version](http://panstamps.readthedocs.org/en/stable/) and [latest version](http://panstamps.readthedocs.org/en/latest/)).

Installation

The easiest way to install panstamps us to use pip:

pip install panstamps

Or you can clone the [github repo](https://github.com/thespacedoctor/panstamps) and install from a local version of the code:

git clone git@github.com:thespacedoctor/panstamps.git cd panstamps python setup.py install

To upgrade to the latest version of panstamps use the command:

pip install panstamps –upgrade

Development

If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:

git clone git@github.com:thespacedoctor/panstamps.git cd panstamps python setup.py develop

[Pull requests](https://github.com/thespacedoctor/panstamps/pulls) are welcomed!

Issues

Please report any issues [here](https://github.com/thespacedoctor/panstamps/issues).

License

Copyright (c) 2016 David Young

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

panstamps-0.2.7.tar.gz (497.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page