Module logbook

Find dive nodes in UDDF files using optional numeric ranges or total
dive number as search parameters.

The collection of dive nodes is returned.

:Parameters:
 files
    Collection of UDDF files.
 nodes
    Numeric ranges of nodes, `None` if all nodes.
 dives
    Numeric range of total dive number, `None` if any dive.

.. seealso:: :py:func:`parse_range`
.. seealso:: :py:func:`find_dives`

Find gas nodes referenced by dives in UDDF files using optional node
ranges as search parameter.

The collection of gas nodes is returned.

:Parameters:
 files
    Collection of UDDF files.
 nodes
    Numeric ranges of nodes, `None` if all nodes.

.. seealso:: :py:func:`parse_range`

Find dive data in UDDF files using optional node ranges or total dive
number as search parameters.

The collection of dive data is returned.

:Parameters:
 files
    Collection of UDDF files.
 nodes
    Numeric ranges of nodes, `None` if all nodes.
 dives
    Numeric range of total dive number, `None` if any dive.

.. seealso:: :py:func:`parse_range`
.. seealso:: :py:func:`find_dive_nodes`

Get generator of preformatted dive data.

The dives are fetched from logbook file and for each dive a tuple of formatted dive information is returned

• dive number, i.e. 102
• date and time of dive, i.e. 2011-03-19 14:56
• maximum depth, i.e. 6.0m
• dive average depth, i.e. 2.0m
• duration of dive, i.e. 33:42
• temperature, i.e. 8.2°C

Parameters:

• dives - Collection of dive data.

Add new dive to logbook file.

The logbook file is created if it does not exist.

If dive number is specified and dive cannot be found then ValueError exception is thrown.

Parameters:

• dive - Dive data.
• lfile - Logbook file.
• qsite - Dive site search term.
• qbuddies - Buddy search terms.

Parameters:

• fin - File with UDDF data to upgrade.

Copy dive nodes to logbook file.

The logbook file is created if it does not exist.

Parameters:

• files - Collection of files.
• nodes - Collection of dive ranges.
• n_dives - Numeric range of total dive number, None if any dive.
• lfile - Logbook file.

Parameters:

• files - Collection of UDDF files having dives to enumerate.
• total - Start of total dive number.