test_nrl.py

# -*- coding: utf-8 -*-
import numpy as np
import pytest

from obspy.core.inventory import (Response, PolesZerosResponseStage,
                                  ResponseStage, CoefficientsTypeResponseStage)
from obspy.clients.nrl.client import NRL, LocalNRL, RemoteNRL


@pytest.mark.network
class TestNRLRemote():
    """
    Minimal NRL test suite connecting to online NRL

    """
    def test_nrl_type(self):
        nrl_online = NRL(root='http://ds.iris.edu/NRL')
        assert isinstance(nrl_online, RemoteNRL)


class TestNRLLocal():
    """
    NRL test suite using stripped down local NRL without network usage.

    """
    @pytest.fixture(autouse=True, scope="function")
    def setup(self, datapath):
        # Longer diffs in the test assertions.
        self.maxDiff = None
        # Small subset of NRL included in tests/data
        self.local_dl_key = ['REF TEK', 'RT 130 & 130-SMA', '1', '1']
        self.local_sensor_key = ['Guralp', 'CMG-3T', '120s - 50Hz', '1500']
        self.local_nrl_root = str(datapath / 'IRIS')
        self.nrl_local = NRL(root=self.local_nrl_root)

    def test_nrl_type(self):
        assert isinstance(self.nrl_local, LocalNRL)

    def test_get_response(self):
        # Get only the sensor response.
        sensor_resp = self.nrl_local.get_sensor_response(self.local_sensor_key)

        # Get only the datalogger response.
        dl_resp = self.nrl_local.get_datalogger_response(self.local_dl_key)

        # Get full response.
        resp = self.nrl_local.get_response(
            datalogger_keys=self.local_dl_key,
            sensor_keys=self.local_sensor_key)

        # Make sure that NRL.get_response() has overall instrument sensitivity
        # correctly recalculated after combining sensor and datalogger
        # information, see #3099.
        # Before fixing this bug the result was 945089653.7285056 which is a
        # relative deviation of 0.00104
        assert resp.instrument_sensitivity.value == pytest.approx(
            944098418.0614196, abs=0, rel=1e-4)

        # All of them should be Response objects.
        assert isinstance(resp, Response)
        assert isinstance(dl_resp, Response)
        assert isinstance(sensor_resp, Response)

        # The full response is the first stage from the sensor and all
        # following from the datalogger.
        assert resp.response_stages[0] == sensor_resp.response_stages[0]
        assert resp.response_stages[1:] == dl_resp.response_stages[1:]

        # Test the actual responses. Testing the parsing of the exact values
        # and what not is done in obspy.io.xseed.
        paz = sensor_resp.response_stages[0]
        assert isinstance(paz, PolesZerosResponseStage)
        np.testing.assert_allclose(
            paz.poles, [(-0.037008 + 0.037008j), (-0.037008 - 0.037008j),
                        (-502.65 + 0j), (-1005 + 0j), (-1131 + 0j)])
        np.testing.assert_allclose(paz.zeros, [0j, 0j])

        assert len(dl_resp.response_stages) == 15
        assert len(resp.response_stages) == 15

        assert isinstance(resp.response_stages[1], ResponseStage)
        for _i in range(2, 15):
            assert isinstance(resp.response_stages[_i],
                              CoefficientsTypeResponseStage)

    def test_nrl_class_str_method(self):
        out = str(self.nrl_local)
        # The local NRL is not going to chance so it is fine to test this.
        assert out.strip() == """
NRL library at %s
  Sensors: 20 manufacturers
    'CEA-DASE', 'CME', 'Chaparral Physics', 'Eentec', 'Generic',
    'Geo Space/OYO', 'Geodevice', 'Geotech', 'Guralp', 'Hyperion',
    'IESE', 'Kinemetrics', 'Lennartz', 'Metrozet', 'Nanometrics',
    'REF TEK', 'Sercel/Mark Products', 'SolGeo',
    'Sprengnether (now Eentec)', 'Streckeisen'
  Dataloggers: 13 manufacturers
    'Agecodagis', 'DAQ Systems (NetDAS)', 'Earth Data', 'Eentec',
    'Generic', 'Geodevice', 'Geotech', 'Guralp', 'Kinemetrics',
    'Nanometrics', 'Quanterra', 'REF TEK', 'SolGeo'
        """.strip() % self.local_nrl_root

    def test_nrl_dict_str_method(self):
        out = str(self.nrl_local.sensors)
        assert out.strip() == """
Select the sensor manufacturer (20 items):
  'CEA-DASE', 'CME', 'Chaparral Physics', 'Eentec', 'Generic',
  'Geo Space/OYO', 'Geodevice', 'Geotech', 'Guralp', 'Hyperion',
  'IESE', 'Kinemetrics', 'Lennartz', 'Metrozet', 'Nanometrics',
  'REF TEK', 'Sercel/Mark Products', 'SolGeo',
  'Sprengnether (now Eentec)', 'Streckeisen'""".strip()

    def test_error_handling_invalid_path(self):
        msg = \
            "Provided path '/some/really/random/path' seems to be a local " \
            "file path but the directory does not exist."
        with pytest.raises(ValueError, match=msg):
            NRL("/some/really/random/path")