:py:mod:`edit_beamset`
======================

.. py:module:: edit_beamset

.. autoapi-nested-parse::

   Example use of BeamSet and subclasses BeamMeasure.

   Copyright (C) CSIRO 2017



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   edit_beamset.arg_init
   edit_beamset.boolify
   edit_beamset.autoconvert
   edit_beamset.show_items
   edit_beamset.check_metadata_items
   edit_beamset.main



Attributes
~~~~~~~~~~

.. autoapisummary::

   edit_beamset.HELPSTART
   edit_beamset.EXPLANATION


.. py:data:: HELPSTART
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """This helps you edit header information (metadata) in a BeamSet file. A new file
        is written with the altered metadata. The interface is simple:
        -s Display all metadata items available for editting.
        -i item will select metadata[item], display its value and, if -v is used, change it.
        -v value, if given will set metadata[item] to value, with a data type the same as the original.
        
        Note that editing metadata items that are lists or arrays is not implemented.
        """

    .. raw:: html

        </details>

   2018-May-19  Add function to check the metadata contents against defaults expected.


.. py:data:: EXPLANATION

   

.. py:function:: arg_init()

   Define the interprestation of command line arguments.
       


.. py:function:: boolify(s)


.. py:function:: autoconvert(s)


.. py:function:: show_items(md)


.. py:function:: check_metadata_items(obj)


.. py:function:: main()