Skip to content

Commit

Permalink
Update README to reflect new features
Browse files Browse the repository at this point in the history
  • Loading branch information
barentsen committed Oct 9, 2016
1 parent aef3742 commit e16dca5
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 16 deletions.
31 changes: 19 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
K2flix: Kepler pixel data visualizer
====================================
**Create beautiful quicklook movies from the pixel data observed by NASA's Kepler spacecraft.**
**Create beautiful quicklook movies from the pixel data observed by NASA's Kepler and TESS spacecraft.**

.. image:: http://img.shields.io/pypi/v/k2flix.svg
:target: https://pypi.python.org/pypi/k2flix/
Expand All @@ -27,8 +27,10 @@ K2flix: Kepler pixel data visualizer
:alt: ADS Bibcode

K2flix makes it easy to inspect the CCD pixel data
obtained by `NASA's Kepler space telescope <http://keplerscience.nasa.gov>`_.
The need for this tool arises from the fact that the two-wheeled extended Kepler mission, K2,
obtained by NASA's `Kepler space telescope <http://keplerscience.nasa.gov>`_,
or simulated data from the future `TESS space telescope <https://tess.gsfc.nasa.gov>`_.

The need for this tool arised from the fact that the two-wheeled extended Kepler mission, K2,
is affected by new sources of noise -- including pointing jitter and foreground asteroids --
which are more easily spotted by eye than by algorithm.

Expand Down Expand Up @@ -87,21 +89,22 @@ K2flix supports reading from web URLs, so you can generate a movie directly from
To see all the options, use the `--help` argument to see the full usage information::
$ k2flix --help
usage: k2flix [-h] [--output FILENAME] [--start START] [--stop STOP]
[--step STEP] [--fps FPS] [--dpi DPI] [--min_cut MIN_CUT]
[--max_cut MAX_CUT] [--min_percent %] [--max_percent %]
[--cmap CMAP] [--raw] [--flags]
usage: k2flix [-h] [-v] [--output FILENAME] [--start START] [--stop STOP]
[--step STEP] [--fps FPS] [--binning BINNING] [--dpi DPI]
[--min_cut MIN_CUT] [--max_cut MAX_CUT] [--min_percent %]
[--max_percent %] [--cmap CMAP] [--raw] [--flags]
[--ut | --jd | --mjd | --bkjd | --cadence]
tpf_filename [tpf_filename ...]

Converts a Target Pixel File (TPF) from NASA's Kepler/K2 spacecraft into an
animated gif (default) or MPEG-4 movie.
Converts a Target Pixel File (TPF) from NASA's Kepler/K2/TESS spacecraft into
an animated gif or MPEG-4 movie for human inspection.

positional arguments:
tpf_filename path to one or more Kepler Target Pixel Files (TPF)
tpf_filename path to one or more Target Pixel Files (TPF)

optional arguments:
-h, --help show this help message and exit
-v, --verbose
--output FILENAME .gif or .mp4 output filename (default: gif with the same
name as the input file)
--start START first frame to show. Give the frame number (default 0),
Expand All @@ -112,6 +115,7 @@ To see all the options, use the `--help` argument to see the full usage informat
if --cadence is set.
--step STEP spacing between frames (default: show 100 frames)
--fps FPS frames per second (default: 15)
--binning BINNING number of cadence to co-add per frame (default: 1)
--dpi DPI resolution of the output in dots per K2 pixel (default:
choose a dpi that produces a 440px-wide image)
--min_cut MIN_CUT minimum cut level (default: use min_percent)
Expand All @@ -129,7 +133,8 @@ To see all the options, use the `--help` argument to see the full usage informat

Citing
------
If you use this tool in an academic publication, please include a citation.
This tool was created by Geert Barentsen at NASA's Kepler/K2 Guest Observer Office.
If this tool aided your research, please include a citation.
The code has been registered in the Astrophysics Source Code Library [`ascl:1503.001 <http://ascl.net/code/v/1069>`_] and the preferred BibTeX entry is::
@MISC{2015ascl.soft03001B,
Expand All @@ -152,4 +157,6 @@ To report bugs and request features, please use the `issue tracker <https://gith

License
-------
Copyright 2016 Geert Barentsen. K2flix is free software made available under the MIT License. For details see the LICENSE file.
Copyright 2016 Geert Barentsen.
K2flix is free software made available under the MIT License.
For details see the LICENSE file.
7 changes: 3 additions & 4 deletions k2flix/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ def k2flix_main(args=None):
"""Script to convert Kepler pixel data (TPF files) to a movie."""
parser = argparse.ArgumentParser(
description="Converts a Target Pixel File (TPF) from NASA's "
"Kepler/K2 spacecraft into an animated gif (default) or MPEG-4 movie.")
"Kepler/K2/TESS spacecraft into an animated gif or MPEG-4 movie for human inspection.")
parser.add_argument('-v', '--verbose', action='store_true',
help='')
parser.add_argument('--output', metavar='FILENAME',
Expand All @@ -604,7 +604,7 @@ def k2flix_main(args=None):
parser.add_argument('--fps', type=float, default=15.,
help='frames per second (default: 15)')
parser.add_argument('--binning', type=int, default=1,
help='number of cadence to co-add per frame'
help='number of cadence to co-add per frame '
'(default: 1)')
parser.add_argument('--dpi', type=float, default=None,
help='resolution of the output in dots per K2 pixel (default: choose a dpi that produces a 440px-wide image)')
Expand All @@ -624,8 +624,7 @@ def k2flix_main(args=None):
parser.add_argument('--flags', action='store_true',
help='show the quality flags')
parser.add_argument('tpf_filename', nargs='+',
help='path to one or more Kepler '
'Target Pixel Files (TPF)')
help='path to one or more Target Pixel Files (TPF)')

group = parser.add_mutually_exclusive_group()
group.add_argument('--ut', action='store_true',
Expand Down

0 comments on commit e16dca5

Please sign in to comment.