Skip to content

Commit

Permalink
deploy: 8070b81
Browse files Browse the repository at this point in the history
  • Loading branch information
seisman committed Mar 27, 2024
1 parent 09e9066 commit c087c34
Show file tree
Hide file tree
Showing 58 changed files with 279 additions and 302 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 2709ca6fba21868986ed9549d19812d7
config: fd398bd1c7225ee8f836bf78e100fb10
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: 'v0.7.2.dev31+g6281ac3',
VERSION: 'v0.7.2.dev37+g8070b81',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 deletions api.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Reference &mdash; HinetPy v0.7.2.dev31+g6281ac3 documentation</title>
<title>API Reference &mdash; HinetPy v0.7.2.dev37+g8070b81 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />

Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=4fa31fe2"></script>
<script src="_static/documentation_options.js?v=51a8fb1f"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
Expand All @@ -37,7 +37,7 @@
HinetPy
</a>
<div class="version">
v0.7.2.dev31+g6281ac3
v0.7.2.dev37+g8070b81
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
67 changes: 29 additions & 38 deletions api/HinetPy.client.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>HinetPy.client module &mdash; HinetPy v0.7.2.dev31+g6281ac3 documentation</title>
<title>HinetPy.client module &mdash; HinetPy v0.7.2.dev37+g8070b81 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />

Expand All @@ -15,7 +15,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=4fa31fe2"></script>
<script src="../_static/documentation_options.js?v=51a8fb1f"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
Expand All @@ -37,7 +37,7 @@
HinetPy
</a>
<div class="version">
v0.7.2.dev31+g6281ac3
v0.7.2.dev37+g8070b81
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -127,18 +127,15 @@ <h1>HinetPy.client module<a class="headerlink" href="#hinetpy-client-module" tit
</dl>
<div class="admonition-notes admonition">
<p class="admonition-title">Notes</p>
<p>The Hi-net server ususally spends 10-60 seconds on data
preparation after receiving a data request. During the data
preparation, users are <strong>NOT</strong> allowed to post another data request.
So users have to wait until the data is ready.</p>
<p>HinetPy checks data status every <code class="docutils literal notranslate"><span class="pre">sleep_time_in_seconds</span></code> seconds for
no more than <code class="docutils literal notranslate"><span class="pre">max_sleep_count</span></code> times, until the data is ready.
If the data status is still NOT ready after
<code class="docutils literal notranslate"><span class="pre">max_sleep_count</span> <span class="pre">*</span> <span class="pre">sleep_time_in_seconds</span></code> seconds,
it most likely means something goes wrong with the data request.
Then, HinetPy will retry to request the data <code class="docutils literal notranslate"><span class="pre">retries</span></code> times.
Ususally, you don’t need to modify these parameters
unless you know what you’re doing.</p>
<p>The Hi-net server ususally spends 10-60 seconds on data preparation after
receiving a data request. During the data preparation, users are <strong>NOT</strong> allowed
to post another data request. So users have to wait until the data is ready.</p>
<p>HinetPy checks data status every <code class="docutils literal notranslate"><span class="pre">sleep_time_in_seconds</span></code> seconds for no more
than <code class="docutils literal notranslate"><span class="pre">max_sleep_count</span></code> times, until the data is ready. If the data status is
still NOT ready after <code class="docutils literal notranslate"><span class="pre">max_sleep_count</span> <span class="pre">*</span> <span class="pre">sleep_time_in_seconds</span></code> seconds, it
most likely means something goes wrong with the data request. Then, HinetPy will
retry to request the data <code class="docutils literal notranslate"><span class="pre">retries</span></code> times. Ususally, you don’t need to modify
these parameters unless you know what you’re doing.</p>
</div>
<div class="admonition-examples admonition">
<p class="admonition-title">Examples</p>
Expand Down Expand Up @@ -249,14 +246,13 @@ <h1>HinetPy.client module<a class="headerlink" href="#hinetpy-client-module" tit
<li><p><strong>code</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Network code. See <a class="reference internal" href="#HinetPy.client.Client.info" title="HinetPy.client.Client.info"><code class="xref py py-meth docutils literal notranslate"><span class="pre">info()</span></code></a> for details.</p></li>
<li><p><strong>starttime</strong> (<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> or str) – Starttime of a data request.</p></li>
<li><p><strong>span</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Time span in minutes.</p></li>
<li><p><strong>max_span</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Maximum time span for sub-requests. Defaults to be determined
automatically. See notes below.</p></li>
<li><p><strong>max_span</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Maximum time span for sub-requests. Defaults to be determined automatically.
See notes below.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Filename of downloaded win32 data.
Default format: CODE_YYYYmmddHHMM_SPAN.cnt</p></li>
<li><p><strong>ctable</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Filename of downloaded channel table file.
Default format: CODE_YYYYmmdd.ch</p></li>
<li><p><strong>outdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Save win32 and channel table data to a specified directory.
Default is in the current directory.</p></li>
<li><p><strong>ctable</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Filename of downloaded channel table file. Default format: CODE_YYYYmmdd.ch</p></li>
<li><p><strong>outdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Save win32 and channel table data to a specified directory. Default is in
the current directory.</p></li>
<li><p><strong>threads</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Parallel data download using more threads.</p></li>
<li><p><strong>cleanup</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Clean up one-minute cnt files after merging.</p></li>
</ul>
Expand All @@ -280,11 +276,10 @@ <h1>HinetPy.client module<a class="headerlink" href="#hinetpy-client-module" tit
<li><p>Number_of_channels * Record_Length &lt;= 12000 min</p></li>
<li><p>Only the latest 150 requested data are kept</p></li>
</ol>
<p>For example, Hi-net network has about 24000 channels. Acoording to
limitation 2, the record length should be no more than 5 minutes
for each data request. HinetPy “break through” the limitation by
splitting a long-duration data request into several short-duration
sub-requsts.</p>
<p>For example, Hi-net network has about 24000 channels. Acoording to limitation 2,
the record length should be no more than 5 minutes for each data request.
HinetPy “break through” the limitation by splitting a long-duration data request
into several short-duration sub-requsts.</p>
<p><strong>How it works</strong></p>
<ol class="arabic simple">
<li><p>do several checks</p></li>
Expand Down Expand Up @@ -355,12 +350,10 @@ <h1>HinetPy.client module<a class="headerlink" href="#hinetpy-client-module" tit
<li><p><strong>maxlongitude</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to events with a longitude smaller than the specified maximum.</p></li>
<li><p><strong>latitude</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Specify the latitude to be used for a radius search.</p></li>
<li><p><strong>longitude</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Specify the longitude to be used for a radius search.</p></li>
<li><p><strong>minradius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to events within the specified minimum number of degrees
from the geographic point defined by the latitude and longitude
parameters.</p></li>
<li><p><strong>maxradius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to events within the specified maximum number of degrees
from the geographic point defined by the latitude and longitude
parameters.</p></li>
<li><p><strong>minradius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to events within the specified minimum number of degrees from the
geographic point defined by the latitude and longitude parameters.</p></li>
<li><p><strong>maxradius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to events within the specified maximum number of degrees from the
geographic point defined by the latitude and longitude parameters.</p></li>
</ul>
</dd>
</dl>
Expand Down Expand Up @@ -496,12 +489,10 @@ <h1>HinetPy.client module<a class="headerlink" href="#hinetpy-client-module" tit
<li><p><strong>maxlongitude</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to stations with a longitude smaller than the specified maximum.</p></li>
<li><p><strong>latitude</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Specify the latitude to be used for a radius search.</p></li>
<li><p><strong>longitude</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Specify the longitude to be used for a radius search.</p></li>
<li><p><strong>minradius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to stations within the specified minimum number of degrees
from the geographic point defined by the latitude and longitude
parameters.</p></li>
<li><p><strong>maxradius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to stations within the specified maximum number of degrees
from the geographic point defined by the latitude and longitude
parameters.</p></li>
<li><p><strong>minradius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to stations within the specified minimum number of degrees from the
geographic point defined by the latitude and longitude parameters.</p></li>
<li><p><strong>maxradius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – Limit to stations within the specified maximum number of degrees from the
geographic point defined by the latitude and longitude parameters.</p></li>
</ul>
</dd>
</dl>
Expand Down
10 changes: 5 additions & 5 deletions api/HinetPy.header.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>HinetPy.header module &mdash; HinetPy v0.7.2.dev31+g6281ac3 documentation</title>
<title>HinetPy.header module &mdash; HinetPy v0.7.2.dev37+g8070b81 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />

Expand All @@ -15,7 +15,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=4fa31fe2"></script>
<script src="../_static/documentation_options.js?v=51a8fb1f"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
Expand All @@ -37,7 +37,7 @@
HinetPy
</a>
<div class="version">
v0.7.2.dev31+g6281ac3
v0.7.2.dev37+g8070b81
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -127,8 +127,8 @@ <h1>HinetPy.header module<a class="headerlink" href="#hinetpy-header-module" tit
<dd><p>Homepage of the network.</p>
</dd></dl>

<p><code class="docutils literal notranslate"><span class="pre">NETWORK</span></code> is a dict of <a class="reference internal" href="#HinetPy.header.Network" title="HinetPy.header.Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network</span></code></a>, containing
information of all networks available from Hi-net website.</p>
<p><code class="docutils literal notranslate"><span class="pre">NETWORK</span></code> is a dict of <a class="reference internal" href="#HinetPy.header.Network" title="HinetPy.header.Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network</span></code></a>, containing information of all
networks available from Hi-net website.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">HinetPy</span> <span class="kn">import</span> <span class="n">NETWORK</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">code</span> <span class="ow">in</span> <span class="n">NETWORK</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">NETWORK</span><span class="p">[</span><span class="n">code</span><span class="p">]</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
Expand Down
10 changes: 5 additions & 5 deletions api/HinetPy.utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>HinetPy.utils module &mdash; HinetPy v0.7.2.dev31+g6281ac3 documentation</title>
<title>HinetPy.utils module &mdash; HinetPy v0.7.2.dev37+g8070b81 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />

Expand All @@ -15,7 +15,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=4fa31fe2"></script>
<script src="../_static/documentation_options.js?v=51a8fb1f"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
Expand All @@ -37,7 +37,7 @@
HinetPy
</a>
<div class="version">
v0.7.2.dev31+g6281ac3
v0.7.2.dev37+g8070b81
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -171,8 +171,8 @@
<dl class="py function">
<dt class="sig sig-object py" id="HinetPy.utils.haversine">
<span class="sig-prename descclassname"><span class="pre">HinetPy.utils.</span></span><span class="sig-name descname"><span class="pre">haversine</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lat1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lon1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lat2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lon2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#HinetPy.utils.haversine" title="Link to this definition"></a></dt>
<dd><p>Calculate the great circle distance between two points on the earth
(specified in decimal degrees) using haversine formula.</p>
<dd><p>Calculate the great circle distance between two points on the earth (specified in
decimal degrees) using haversine formula.</p>
<p>Reference: <a class="reference external" href="https://stackoverflow.com/a/4913653/7770208">https://stackoverflow.com/a/4913653/7770208</a>.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">haversine</span><span class="p">(</span><span class="mi">40</span><span class="p">,</span> <span class="mi">130</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">140</span><span class="p">)</span>
<span class="go">12.224069629545902</span>
Expand Down
Loading

0 comments on commit c087c34

Please sign in to comment.