You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

303 lines
20 KiB
HTML

<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8" />
<title>Software Development Kit &#8212; SeisComP Release documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<script type="text/javascript" src="../_static/seiscomp.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Python" href="sdk-python.html" />
<link rel="prev" title="Filter grammar" href="filter-grammar.html" />
</head>
<body>
<div class="header">
<div class="container">
<div class="brand">
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
<!-- span class="title">SeisComP Release</span -->
<span class="version">5.3.0</span>
</div>
</div>
</div>
<div class="nav">
<div class="container">
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="right">
<a href="../genindex.html" title="General Index"
accesskey="I">
index
</a>
</li>
<li class="right">
<a href="sdk-python.html" title="Python"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="filter-grammar.html" title="Filter grammar"
accesskey="P">
previous
</a>
</li>
<li class="nav-item nav-item-0">
<a href="../index.html">Home</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<div class="section" id="software-development-kit">
<span id="sdk"></span><h1>Software Development Kit<a class="headerlink" href="#software-development-kit" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="sdk-python.html">Python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sdk-python-packages.html">Packages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api-python.html">seiscomp.datamodel</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api-python.html#base-objects">Base Objects</a></li>
<li class="toctree-l4"><a class="reference internal" href="api-python.html#domain-overview">Domain Overview</a><ul>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#eventparameters">EventParameters</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#config">Config</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#qualitycontrol">QualityControl</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#inventory">Inventory</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#routing">Routing</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#journaling">Journaling</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#arclinklog">ArclinkLog</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#dataavailability">DataAvailability</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="api-python.html#enumerations">Enumerations</a></li>
<li class="toctree-l4"><a class="reference internal" href="api-python.html#reference">Reference</a><ul>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#object">Object</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#publicobject">PublicObject</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#notifier">Notifier</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#access">Access</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#amplitude">Amplitude</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#amplitudereference">AmplitudeReference</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#api-python-datamodel-arclinklog">ArclinkLog</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#arclinkrequest">ArclinkRequest</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#arclinkrequestline">ArclinkRequestLine</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#arclinkrequestsummary">ArclinkRequestSummary</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#arclinkstatusline">ArclinkStatusLine</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#arclinkuser">ArclinkUser</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#arrival">Arrival</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#auxdevice">AuxDevice</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#auxsource">AuxSource</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#auxstream">AuxStream</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#axis">Axis</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#blob">Blob</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#comment">Comment</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#complexarray">ComplexArray</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#compositetime">CompositeTime</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#confidenceellipsoid">ConfidenceEllipsoid</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#api-python-datamodel-config">Config</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#configmodule">ConfigModule</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#configstation">ConfigStation</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#creationinfo">CreationInfo</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#dataattributeextent">DataAttributeExtent</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#api-python-datamodel-dataavailability">DataAvailability</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#dataextent">DataExtent</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#datasegment">DataSegment</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#dataused">DataUsed</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#datalogger">Datalogger</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#dataloggercalibration">DataloggerCalibration</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#decimation">Decimation</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#event">Event</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#eventdescription">EventDescription</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#api-python-datamodel-eventparameters">EventParameters</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#focalmechanism">FocalMechanism</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#focalmechanismreference">FocalMechanismReference</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#integerquantity">IntegerQuantity</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#api-python-datamodel-inventory">Inventory</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#journalentry">JournalEntry</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#api-python-datamodel-journaling">Journaling</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#magnitude">Magnitude</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#momenttensor">MomentTensor</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#momenttensorcomponentcontribution">MomentTensorComponentContribution</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#momenttensorphasesetting">MomentTensorPhaseSetting</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#momenttensorstationcontribution">MomentTensorStationContribution</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#network">Network</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#nodalplane">NodalPlane</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#nodalplanes">NodalPlanes</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#origin">Origin</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#originquality">OriginQuality</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#originreference">OriginReference</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#originuncertainty">OriginUncertainty</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#outage">Outage</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#parameter">Parameter</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#parameterset">ParameterSet</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#phase">Phase</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#pick">Pick</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#pickreference">PickReference</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#principalaxes">PrincipalAxes</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#qclog">QCLog</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#api-python-datamodel-qualitycontrol">QualityControl</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#reading">Reading</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#realarray">RealArray</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#realpdf1d">RealPDF1D</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#realquantity">RealQuantity</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#responsefap">ResponseFAP</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#responsefir">ResponseFIR</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#responseiir">ResponseIIR</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#responsepaz">ResponsePAZ</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#responsepolynomial">ResponsePolynomial</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#route">Route</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#routearclink">RouteArclink</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#routeseedlink">RouteSeedlink</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#api-python-datamodel-routing">Routing</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#sensor">Sensor</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#sensorcalibration">SensorCalibration</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#sensorlocation">SensorLocation</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#setup">Setup</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#sourcetimefunction">SourceTimeFunction</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#station">Station</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#stationgroup">StationGroup</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#stationmagnitude">StationMagnitude</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#stationmagnitudecontribution">StationMagnitudeContribution</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#stationreference">StationReference</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#stream">Stream</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#tensor">Tensor</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#timearray">TimeArray</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#timepdf1d">TimePDF1D</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#timequantity">TimeQuantity</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#timewindow">TimeWindow</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#waveformquality">WaveformQuality</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python.html#waveformstreamid">WaveformStreamID</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api-python-client.html">seiscomp.client</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api-python-client.html#application-class">Application class</a><ul>
<li class="toctree-l5"><a class="reference internal" href="api-python-client.html#constructor">Constructor</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python-client.html#init">Init</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python-client.html#run">Run</a></li>
<li class="toctree-l5"><a class="reference internal" href="api-python-client.html#done">Done</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="api-python-client.html#streamapplication-class">StreamApplication class</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sdk-python-examples.html">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="sdk-python-examples.html#simple-messaging-client">Simple messaging client</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#summary">Summary</a></li>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#goal">Goal</a></li>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#script">Script</a><ul>
<li class="toctree-l5"><a class="reference internal" href="sdk-python-examples.html#event-listener-py">event-listener.py</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="sdk-python-examples.html#inventory-examples">Inventory examples</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#id1">Summary</a></li>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#id2">Goal</a></li>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#scripts">Scripts</a><ul>
<li class="toctree-l5"><a class="reference internal" href="sdk-python-examples.html#configured-streams-py">configured-streams.py</a></li>
<li class="toctree-l5"><a class="reference internal" href="sdk-python-examples.html#station-coordinates-py">station-coordinates.py</a></li>
<li class="toctree-l5"><a class="reference internal" href="sdk-python-examples.html#channel-gains-py">channel-gains.py</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="sdk-python-examples.html#simple-waveform-client">Simple waveform client</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#id3">Summary</a></li>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#id4">Goal</a></li>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#id5">Script</a><ul>
<li class="toctree-l5"><a class="reference internal" href="sdk-python-examples.html#waveform-client-py">waveform-client.py</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="sdk-python-examples.html#waveform-client-and-record-filtering">Waveform client and record filtering</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#id6">Summary</a></li>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#id7">Goal</a></li>
<li class="toctree-l4"><a class="reference internal" href="sdk-python-examples.html#id8">Script</a><ul>
<li class="toctree-l5"><a class="reference internal" href="sdk-python-examples.html#waveform-filter-py">waveform-filter.py</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="anchors-bottom"></div>
</div>
<div class="sidebar" role="navigation" aria-label="main navigation">
<div id="anchors-top"></div>
<div id="anchors" class="content">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="filter-grammar.html"
title="previous chapter">Filter grammar</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="sdk-python.html"
title="next chapter">Python</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/base/sdk.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<div class="horizontal layout content">
<a class="fade-in" href="https://www.gempa.de" target="_blank">
<img class="brand" src="../_static/brands/gempa.svg"/>
</a>
<div class="stretched align-center fitted content">
<div>
Version <b>5.3.0</b> Release
</div>
<div class="copyright">
Copyright &copy; gempa GmbH, GFZ Potsdam.
</div>
</div>
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
<img class="brand" src="../_static/brands/gfz.svg"/>
</a>
</div>
</div>
</div>
</body>
</html>