obspy.core.event.read_events

read_events(pathname_or_url=None, format=None, **kwargs)

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 or StringIO.StringIO, optional) 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 Catalog object will be returned.
  • format (str, optional) Format of the file to read (e.g. "QUAKEML"). See the Supported Formats section below for a list of supported formats.
Returns:

A 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 Required Module Linked Function Call
CMTSOLUTION obspy.io.cmtsolution obspy.io.cmtsolution.core._read_cmtsolution()
FNETMT obspy.io.nied obspy.io.nied.fnetmt._read_fnetmt_catalog()
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()
QUAKEML obspy.io.quakeml obspy.io.quakeml.core._read_quakeml()
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.