def read_inventory(path_or_file_object=None, format=None, *args, **kwargs):
"""
Function to read inventory files.
:type path_or_file_object: str or file-like object.
:param path_or_file_object: String containing a file name or a URL or a
open file-like object. Wildcards are allowed for a file name. If this
attribute is omitted, an example
:class:`~obspy.core.inventory.inventory.Inventory` object will be
returned.
:type format: str
:param format: Format of the file to read (e.g. ``"STATIONXML"``). See the
`Supported Formats`_ section below for a list of supported formats.
:rtype: :class:`~obspy.core.inventory.inventory.Inventory`
:return: An ObsPy :class:`~obspy.core.inventory.inventory.Inventory`
object.
Additional args and kwargs are passed on to the underlying ``_read_X()``
methods of the inventory plugins.
.. rubric:: _`Supported Formats`
Additional ObsPy modules extend the functionality of the
:func:`~obspy.core.inventory.inventory.read_inventory` function. The
following table summarizes all known file formats currently supported by
ObsPy.
Please refer to the `Linked Function Call`_ of each module for any extra
options available at the import stage.
%s
.. note::
For handling additional information not covered by the
StationXML standard and how to output it to StationXML
see the :ref:`ObsPy Tutorial <stationxml-extra>`.
"""
if path_or_file_object is None:
# if no pathname or URL specified, return example catalog
return _create_example_inventory()
else:
return _generic_reader(path_or_file_object,
_read,
format=format,
**kwargs)
def read_inventory(path_or_file_object=None, format=None, *args, **kwargs):
"""
Function to read inventory files.
:type path_or_file_object: str or file-like object.
:param path_or_file_object: String containing a file name or a URL or a
open file-like object. Wildcards are allowed for a file name. If this
attribute is omitted, an example
:class:`~obspy.core.inventory.inventory.Inventory` object will be
returned.
:type format: str
:param format: Format of the file to read (e.g. ``"STATIONXML"``). See the
`Supported Formats`_ section below for a list of supported formats.
:rtype: :class:`~obspy.core.inventory.inventory.Inventory`
:return: An ObsPy :class:`~obspy.core.inventory.inventory.Inventory`
object.
Additional args and kwargs are passed on to the underlying ``_read_X()``
methods of the inventory plugins.
.. rubric:: _`Supported Formats`
Additional ObsPy modules extend the functionality of the
:func:`~obspy.core.inventory.inventory.read_inventory` function. The
following table summarizes all known file formats currently supported by
ObsPy.
Please refer to the `Linked Function Call`_ of each module for any extra
options available at the import stage.
%s
.. note::
For handling additional information not covered by the
StationXML standard and how to output it to StationXML
see the :ref:`ObsPy Tutorial <stationxml-extra>`.
"""
if path_or_file_object is None:
# if no pathname or URL specified, return example catalog
return _create_example_inventory()
else:
return _generic_reader(path_or_file_object, _read, format=format,
**kwargs)
def read_events(pathname_or_url=None, format=None, **kwargs):
"""
Read event files into an ObsPy
:class:`~obspy.core.event.catalog.Catalog` object.
The :func:`~obspy.core.event.read_events` function opens either one or
multiple event files given via file name or URL using the
``pathname_or_url`` attribute.
:type pathname_or_url: str, pathlib.Path, or file-like object, optional
:param pathname_or_url: String containing a file name or a URL, Path
object, or an open file-like object. Wildcards are allowed for a file
name. If this attribute is omitted, an example
:class:`~obspy.core.event.Catalog` object will be returned.
:type format: str
:param format: Format of the file to read (e.g. ``"QUAKEML"``). See the
`Supported Formats`_ section below for a list of supported formats.
:rtype: :class:`~obspy.core.event.Catalog`
:return: An ObsPy :class:`~obspy.core.event.Catalog` object.
.. rubric:: _`Supported Formats`
Additional ObsPy modules extend the functionality of the
:func:`~obspy.core.event.read_events` function. The following table
summarizes all known file formats currently supported by ObsPy.
Please refer to the `Linked Function Call`_ of each module for any extra
options available at the import stage.
%s
Next to the :func:`~obspy.core.event.read_events` function the
:meth:`~obspy.core.event.catalog.Catalog.write` method of the returned
:class:`~obspy.core.event.catalog.Catalog` object can be used to export the
data to the file system.
"""
if pathname_or_url is None:
# if no pathname or URL specified, return example catalog
return _create_example_catalog()
else:
return _generic_reader(pathname_or_url, _read, format=format, **kwargs)
def read_events(pathname_or_url=None, format=None, **kwargs):
"""
Read event files into an ObsPy Catalog object.
The :func:`~obspy.core.event.read_events` function opens either one or
multiple event files given via file name or URL using the
``pathname_or_url`` attribute.
:type pathname_or_url: str or StringIO.StringIO
:param pathname_or_url: String containing a file name or a URL or a open
file-like object. Wildcards are allowed for a file name. If this
attribute is omitted, an example :class:`~obspy.core.event.Catalog`
object will be returned.
:type format: str
:param format: Format of the file to read (e.g. ``"QUAKEML"``). See the
`Supported Formats`_ section below for a list of supported formats.
:rtype: :class:`~obspy.core.event.Catalog`
:return: An ObsPy :class:`~obspy.core.event.Catalog` object.
.. rubric:: _`Supported Formats`
Additional ObsPy modules extend the functionality of the
:func:`~obspy.core.event.read_events` function. The following table
summarizes all known file formats currently supported by ObsPy.
Please refer to the `Linked Function Call`_ of each module for any extra
options available at the import stage.
%s
Next to the :func:`~obspy.core.event.read_events` function the
:meth:`~obspy.core.event.Catalog.write` method of the returned
:class:`~obspy.core.event.Catalog` object can be used to export the data to
the file system.
"""
if pathname_or_url is None:
# if no pathname or URL specified, return example catalog
return _create_example_catalog()
else:
return _generic_reader(pathname_or_url, _read, format=format, **kwargs)
