mth5.clients.uoa
================

.. py:module:: mth5.clients.uoa

.. autoapi-nested-parse::

   UoA Client
   ==========

   Client for creating MTH5 files from University of Adelaide instrument data.
   Supports both PR6-24 (Earth Data Logger) and Orange Box instruments.

   Created on Thu Nov 7 15:35:00 2025

   @author: bkay



Classes
-------

.. autoapisummary::

   mth5.clients.uoa.UoAClient


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

.. py:class:: UoAClient(data_path, save_path=None, instrument_type='pr624', mth5_filename='from_uoa.h5', **kwargs)

   Bases: :py:obj:`mth5.clients.base.ClientBase`


   Client for creating MTH5 files from University of Adelaide instrument data.

   Supports:
   - **PR6-24 (Earth Data Logger)**: ASCII files (.BX, .BY, .BZ, .EX, .EY)
   - **Orange Box**: Binary files (.BIN)

   :param data_path: Path to directory or file(s)
   :type data_path: str or pathlib.Path
   :param save_path: Path to save MTH5 file, defaults to data_path
   :type save_path: str or pathlib.Path, optional
   :param instrument_type: 'pr624' or 'orange', defaults to 'pr624'
   :type instrument_type: str, optional
   :param mth5_filename: Name of output MTH5 file, defaults to "from_uoa.h5"
   :type mth5_filename: str, optional

   :Example:

       >>> from mth5.clients import UoAClient
       >>> # PR6-24 data
       >>> uc = UoAClient("/path/to/pr624/data", instrument_type='pr624')
       >>> mth5_path = uc.make_mth5_from_uoa(
       ...     survey_id="Survey01",
       ...     station_id="MT001",
       ...     sample_rate=10.0,
       ...     dipole_length_ex=50.0,
       ...     dipole_length_ey=50.0
       ... )
       >>>
       >>> # Orange Box data
       >>> uc = UoAClient("/path/to/orange/data", instrument_type='orange')
       >>> mth5_path = uc.make_mth5_from_uoa(
       ...     survey_id="Survey01",
       ...     station_id="ST61",
       ...     dipole_length_ex=100.0,
       ...     dipole_length_ey=100.0
       ... )



   .. py:attribute:: instrument_type
      :value: ''



   .. py:method:: make_mth5_from_uoa(survey_id, station_id, run_id='001', **kwargs)

      Create an MTH5 file from UoA instrument data.

      :param survey_id: Survey identifier
      :type survey_id: str
      :param station_id: Station identifier
      :type station_id: str
      :param run_id: Run identifier, defaults to "001"
      :type run_id: str, optional
      :param kwargs: Additional keyword arguments for reader:

          **PR6-24 arguments:**
              - sample_rate (float): REQUIRED - sample rate in Hz
              - sensor_type (str): 'bartington' or 'lemi120'
              - dipole_length_ex (float): Ex dipole length in meters
              - dipole_length_ey (float): Ey dipole length in meters
              - calibration_fn_bx (str): LEMI-120 .rsp file for Bx
              - calibration_fn_by (str): LEMI-120 .rsp file for By
              - calibration_fn_bz (str): LEMI-120 .rsp file for Bz
              - latitude (float): Station latitude
              - longitude (float): Station longitude
              - elevation (float): Station elevation

          **Orange Box arguments:**
              - dipole_length_ex (float): Ex dipole length in meters
              - dipole_length_ey (float): Ey dipole length in meters
              - latitude (float): Station latitude
              - longitude (float): Station longitude
              - elevation (float): Station elevation

      :type kwargs: dict
      :return: Path to created MTH5 file
      :rtype: pathlib.Path

      :Example:

          >>> from mth5.clients import UoAClient
          >>> # PR6-24 long-period data
          >>> uc = UoAClient("/data/pr624", instrument_type='pr624')
          >>> mth5_file = uc.make_mth5_from_uoa(
          ...     survey_id="MySurvey",
          ...     station_id="MT001",
          ...     sample_rate=10.0,
          ...     sensor_type='bartington',
          ...     dipole_length_ex=50.0,
          ...     dipole_length_ey=50.0
          ... )
          >>>
          >>> # Orange Box data
          >>> uc = UoAClient("/data/orange", instrument_type='orange')
          >>> mth5_file = uc.make_mth5_from_uoa(
          ...     survey_id="MySurvey",
          ...     station_id="ST61",
          ...     dipole_length_ex=100.0,
          ...     dipole_length_ey=100.0
          ... )