Skip to content

Latest commit

 

History

History
168 lines (113 loc) · 4.12 KB

README.rst

File metadata and controls

168 lines (113 loc) · 4.12 KB

Pysky

AstroPy Travis (.org) Code style: black Codecov https://img.shields.io/badge/license-AGPLv3-green:alt:License:AGPLv3 GitHub last commit

Download & Installation

Initial setup

Download and install latest version of Python here.

Follow these instructions to get the latest version of pip.

~$ git clone https://github.com/allenerocha/pysky.git && cd pysky/
pysky/$ pip install .

Uninstalling

~$ pip uninstall pysky -y

Usage

~$ pysky -sd [start date] -st [start time] -ed [end date] -et [end time] -t [thread count] -v [verbosity level]

Command line options

Options (Dates and times are in ISO 8601 format)

-sd/--startdate Starting date. [1]
-st/--starttime Starting time. [1]
-ed/--enddate Ending date. [2]
-et/--endtime Ending time. [2]
-t/--threads Number of threads to use. [2]
-v/--verbosity Verbosity level. [2]
-h/--help Display help for the CL options.
[1](1, 2) Required.
[2](1, 2, 3, 4) Optional.

Date format (YEAR-MONTH-DAY)

YEAR 4 digit format
MONTH 2 digit format
DAY 2 digit format

Time format (HOUR:MINUTE)

HOUR 24 hour format (0-23)
MINUTE Minute in regular format (0-59)

Specifying no end date and time defaults the search to only go for one hour long.

Help

~$ pysky -h
~$ pysky --help

Images

Default

By default images of valid objects will be saved in the filename format:

$HOME/PySkySlideshow/object-width-height-resolution-scaling.png

User Defined

To change the location of the saved images, you can add the following line to the user_prefs.cfg file:

slideshow_dir=

Followed by the directory to save in. The folder PySkySlideshow will be created in the specified directory.

Examples

slideshow_dir=/home/allen

This will set the directory to save the images as:

slideshow_dir=/home/allen/PySkySlideshow/

Usage

Start July 10th, 2012 17:00 End July 10th, 2012 23:00

$ pysky -sd 2012-07-10 -st 17:00 -ed 2012-07-10 -et 23:00

Start December 31st, 2015 08:00 End January 1st, 2016 02:00 with high verbosity

$ pysky -sd 2015-12-31 -st 08:00 -ed 2016-01-01 -et 02:00 -v 5

Start September 1st, 2019 19:00 for one hour with 2 threads and medium verbosity

$ pysky -sd 2019-09-01 -st 17:00 -t 2 -v 3

Supported Python Versions

Python 3.6+