usual series of doc updates for new commands

docs/change_log_0.21.0_0.22.0.rst

@@ -1,4 +1,4 @@
-.. changelog created on Thu 13 May 17:53:37 BST 2021
+.. changelog created on Sat 15 May 16:04:42 BST 2021
 
 .. include:: globals.rst
 

docs/commands.rst

@@ -30,6 +30,7 @@
 .. |ol-makebias| replace:: combine a run to make a bias frame
 .. |ol-makedark| replace:: combine a run to make a dark frame
 .. |ol-makeflat| replace:: combine a list of frames into a flat
+.. |ol-makemovie| replace:: makes stills for movies from a run
 .. |ol-mstats|   replace:: list stats of multiple frames from a run
 .. |ol-mul|      replace:: multiply two frames
 .. |ol-nrtplot|  replace:: plot frames as they come in [matplotlib]
@@ -127,6 +128,8 @@ useful.
    +--------------+----------------+----------+----------+---------+-----------+------------+
    | |makeflat|   | |ol-makeflat|  |          | Yes      |         |           |            |
    +--------------+----------------+----------+----------+---------+-----------+------------+
+   | |makemovie|  | |ol-makemovie| |          |          | Yes     |           | Yes        |
+   +--------------+----------------+----------+----------+---------+-----------+------------+
    | |mstats|     | |ol-mstats|    |          |          |         |           | Yes        |
    +--------------+----------------+----------+----------+---------+-----------+------------+
    | |mul|        | |ol-mul|       |          |          |         |   Yes     |            |
@@ -449,6 +452,7 @@ extension '.hcm' to distinguish them, although they are also FITS-format files.
 .. autofunction:: hipercam.scripts.makebias
 .. autofunction:: hipercam.scripts.makedark
 .. autofunction:: hipercam.scripts.makeflat
+.. autofunction:: hipercam.scripts.makemovie
 .. autofunction:: hipercam.scripts.mstats
 .. autofunction:: hipercam.scripts.mul
 .. autofunction:: hipercam.scripts.nrtplot

docs/globals.rst

@@ -41,6 +41,7 @@
 .. |makebias| replace:: :func:`makebias <hipercam.scripts.makebias>`
 .. |makedark| replace:: :func:`makedark <hipercam.scripts.makedark>`
 .. |makeflat| replace:: :func:`makeflat <hipercam.scripts.makeflat>`
+.. |makemovie| replace:: :func:`makemovie <hipercam.scripts.makemovie>`
 .. |mstats| replace:: :func:`mstats <hipercam.scripts.mstats>`
 .. |mul| replace:: :func:`mul <hipercam.scripts.mul>`
 .. |nrtplot| replace:: :func:`nrtplot <hipercam.scripts.nrtplot>`

docs/index.rst

@@ -35,6 +35,7 @@ more information on
    installation
    files
    api/bugs
+   makingmovies
 
 Indices and tables
 ==================

docs/makingmovies.rst

@@ -0,0 +1,30 @@
+.. how to make movies doc created on 03/02/2018
+
+.. include:: globals.rst
+
+.. highlightlang:: rest
+
+Making movies from |hiper| data
+*******************************
+
+The |makemovie| command allows you to generate stills from a movie. It
+is however painful to use and even more to actually compile, so this
+is just to provide an easy reminder.
+
+Making the stills
+=================
+
+TBD
+
+Making the movie from the stills
+================================
+
+I use 'ffmpeg' to make the movie with a command like::
+
+  ``ffmpeg -start_number 123 -i run0005_%04d.png -c:v libx264 -pix_fmt yuv420p movie.mp4 -y``
+
+which would find any files of the form 'run0005_0340.png' starting from 'run0005_0123.png'.
+
+
+
+

hipercam/scripts/joinup.py

@@ -28,7 +28,7 @@ def joinup(args=None):
     "standard" FITS files with one image in the primary HDU per file,
     representing a single CCD with all windows merged. The aim above
     all is to have a file that plays nicely with 'ds9'. A file such as
-    'run0002.fits' (|hipercam|) will end up producing files with names
+    'run0002.fits' (|hiper|) will end up producing files with names
     like run0002_ccd1_0001.fits, run0002_ccd1_0002.fits, etc and the
     same for any of the other CCDs. They will be written to the
     present working directory. If the windows have gaps, then they