obspy.core.event.read_events

read_events(pathname_or_url=None, format=None, **kwargs)[source]

Read event files into an ObsPy Catalog object.

The read_events() function opens either one or multiple event files given via file name or URL using the pathname_or_url attribute.

Parameters:
  • pathname_or_url (str, pathlib.Path, or file-like object, optional) – 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 Catalog object will be returned.

  • format (str) – Format of the file to read (e.g. "QUAKEML"). See the Supported Formats section below for a list of supported formats.

Return type:

Catalog

Returns:

An ObsPy Catalog object.

Supported Formats

Additional ObsPy modules extend the functionality of the 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.

Format

Used Module

Linked Function Call

CMTSOLUTION

obspy.io.cmtsolution

obspy.io.cmtsolution.core._read_cmtsolution()

EVT

obspy.io.sh

obspy.io.sh.evt._read_evt()

FNETMT

obspy.io.nied

obspy.io.nied.fnetmt._read_fnetmt_catalog()

FOCMEC

obspy.io.focmec

obspy.io.focmec.core._read_focmec()

GSE2

obspy.io.gse2

obspy.io.gse2.bulletin._read_gse2()

HYPODDPHA

obspy.io.hypodd

obspy.io.hypodd.pha._read_pha()

IMS10BULLETIN

obspy.io.iaspei

obspy.io.iaspei.core._read_ims10_bulletin()

MCHEDR

obspy.io.pde

obspy.io.pde.mchedr._read_mchedr()

NDK

obspy.io.ndk

obspy.io.ndk.core._read_ndk()

NLLOC_HYP

obspy.io.nlloc

obspy.io.nlloc.core.read_nlloc_hyp()

NORDIC

obspy.io.nordic

obspy.io.nordic.core.read_nordic()

QUAKEML

obspy.io.quakeml

obspy.io.quakeml.core._read_quakeml()

SC3ML

obspy.io.seiscomp

obspy.io.seiscomp.event._read_sc3ml()

SCARDEC

obspy.io.scardec

obspy.io.scardec.core._read_scardec()

ZMAP

obspy.io.zmap

obspy.io.zmap.core._read_zmap()

Next to the read_events() function the write() method of the returned Catalog object can be used to export the data to the file system.