.. index::
   single: ebas_instrument_inventory; program

.. program:: ebas_instrument_inventory

.. _EBASprogram_ebas_instrument_inventory:

ebas_instrument_inventory
=============

.. versionadded:: 3.02.01

The program *ebas_instrument_inventory* generates an inventory of datasets
available in the EBAS database.

The availability will is shown per instrument (:term:`Instrument reference`).
Optionally, the availability can be shown per :term:`instrument reference` and
year (option :option:`--by-year`).

In both cases, the  availability is shown as
:term:`instrument years <instrument-year>`. In case of :option:`--by-year`, the
result will be between 0.0 and 1.0 (one full instrument year), which means, the
result represents also the fraction of time covered by measurements by this
instrument in the given year (instrument coverage per year).


Synopsis
--------

::

   ebas_instrument_inventory.py [-h] [--version] [--cfgfile CFGFILE]
                                [--loglevconsole LOGLEVCONSOLE]
                                [--loglevfile LOGLEVFILE]
                                [--logfile LOGFILE] [--profile] [--nodb]
                                [--dbHost DBHOST] [--db DB]
                                [--dbUser DBUSER] [--dbPasswd DBPASSWD]
                                [--do_id DO_ID] [--setkey SETKEY]
                                [--station STATION] [--project PROJECT]
                                [--instrument INSTRUMENT]
                                [--component COMPONENT] [--matrix MATRIX]
                                [--group GROUP] [--fi_ref FI_REF]
                                [--me_ref ME_REF]
                                [--resolution RESOLUTION]
                                [--statistics STATISTICS]
                                [--datalevel DATALEVEL] [--time TIME]
                                [--state STATE] [--diff DIFF] [--by-year]

Commandline arguments
---------------------

.. include:: ./include/commandline_arguments/intro.include

General arguments
^^^^^^^^^^^^^^^^^

.. include:: ./include/commandline_arguments/general.include


Configuration arguments
^^^^^^^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/config.include


Logging arguments
^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/logging.include


Database arguments
^^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/db.include


Commandline arguments for dataset selection criteria
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Dataset selection criteria are used to define a set of datasets to be used
by *ebas_instrument_inventory*.

.. include:: include/commandline_arguments/ds_criteria.include


Time interval criteria
^^^^^^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/time.include


History arguments
^^^^^^^^^^^^^^^^^

.. include:: include/commandline_arguments/state.include


Arguments specific to *ebas_instrument_inventory*
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. option:: --by-year

   Verbose output, multiple lines per dataset.