Skip to content

Commit

Permalink
deploy: 9e5296a
Browse files Browse the repository at this point in the history
  • Loading branch information
JunjieYU-UoM committed May 2, 2024
1 parent 79f404e commit d28f770
Show file tree
Hide file tree
Showing 7 changed files with 327 additions and 10 deletions.
65 changes: 65 additions & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,73 @@
<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
<a href="#G"><strong>G</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#O"><strong>O</strong></a>
| <a href="#R"><strong>R</strong></a>

</div>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="obswx.html#obswx.obswx.obswx.get_data">get_data() (obswx.obswx.obswx method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="obswx.html#obswx.obswx.obswx.get_location">get_location() (obswx.obswx.obswx method)</a>
</li>
<li><a href="obswx.html#obswx.obswx.obswx.get_meta">get_meta() (obswx.obswx.obswx method)</a>
</li>
</ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
module

<ul>
<li><a href="obswx.html#module-obswx.obswx">obswx.obswx</a>
</li>
<li><a href="obswx.html#module-obswx.utils">obswx.utils</a>
</li>
</ul></li>
</ul></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="obswx.html#obswx.obswx.obswx">obswx (class in obswx.obswx)</a>
</li>
<li>
obswx.obswx

<ul>
<li><a href="obswx.html#module-obswx.obswx">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
obswx.utils

<ul>
<li><a href="obswx.html#module-obswx.utils">module</a>
</li>
</ul></li>
</ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="obswx.html#obswx.utils.read_hadisd">read_hadisd() (in module obswx.utils)</a>
</li>
</ul></td>
</tr></table>



</div>
Expand Down
2 changes: 1 addition & 1 deletion hadisd_map.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
var southWest = bounds.getSouthWest();
var northEast = bounds.getNorthEast();
// 读取CSV文件并解析数据
fetch('https://raw.githubusercontent.com/envdes/pywx/raw/main/docs/UK-hist-stataion-meta.csv')
fetch('https://raw.githubusercontent.com/envdes/obswx/raw/main/docs/hadisd_meta.csv')
.then(response => response.text())
.then(csvText => {
console.log(csvText); // 打印 CSV 文件内容
Expand Down
15 changes: 13 additions & 2 deletions modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,19 @@ <h1>obswx<a class="headerlink" href="#obswx" title="Permalink to this heading">
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="obswx.html">obswx package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="obswx.html#obswx-module">obswx module</a></li>
<li class="toctree-l2"><a class="reference internal" href="obswx.html#other-modules">other modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="obswx.html#module-obswx.obswx">obswx module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="obswx.html#obswx.obswx.obswx"><code class="docutils literal notranslate"><span class="pre">obswx</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="obswx.html#obswx.obswx.obswx.get_data"><code class="docutils literal notranslate"><span class="pre">obswx.get_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="obswx.html#obswx.obswx.obswx.get_location"><code class="docutils literal notranslate"><span class="pre">obswx.get_location()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="obswx.html#obswx.obswx.obswx.get_meta"><code class="docutils literal notranslate"><span class="pre">obswx.get_meta()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="obswx.html#module-obswx.utils">other modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="obswx.html#obswx.utils.read_hadisd"><code class="docutils literal notranslate"><span class="pre">read_hadisd()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down
Binary file modified objects.inv
Binary file not shown.
108 changes: 102 additions & 6 deletions obswx.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,14 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">obswx</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">obswx package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#obswx-module">obswx module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#other-modules">other modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-obswx.obswx">obswx module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#obswx.obswx.obswx"><code class="docutils literal notranslate"><span class="pre">obswx</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-obswx.utils">other modules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#obswx.utils.read_hadisd"><code class="docutils literal notranslate"><span class="pre">read_hadisd()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -95,11 +101,101 @@

<section id="obswx-package">
<h1>obswx package<a class="headerlink" href="#obswx-package" title="Permalink to this heading"></a></h1>
<section id="obswx-module">
<h2>obswx module<a class="headerlink" href="#obswx-module" title="Permalink to this heading"></a></h2>
<section id="module-obswx.obswx">
<span id="obswx-module"></span><h2>obswx module<a class="headerlink" href="#module-obswx.obswx" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="obswx.obswx.obswx">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">obswx.obswx.</span></span><span class="sig-name descname"><span class="pre">obswx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ISD'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#obswx.obswx.obswx" title="Permalink to this definition"></a></dt>
<dd><p class="rubric">Methods</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#obswx.obswx.obswx.get_data" title="obswx.obswx.obswx.get_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_data</span></code></a>(**kwargs)</p></td>
<td><p>Get data</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#obswx.obswx.obswx.get_location" title="obswx.obswx.obswx.get_location"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_location</span></code></a>(lat, lon, **kwargs)</p></td>
<td><p>Get location of the station</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#obswx.obswx.obswx.get_meta" title="obswx.obswx.obswx.get_meta"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_meta</span></code></a>(**kwargs)</p></td>
<td><p>Get metadata</p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="obswx.obswx.obswx.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#obswx.obswx.obswx.get_data" title="Permalink to this definition"></a></dt>
<dd><p>Get data</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>year</strong> – int, year of the data</p></li>
<li><p><strong>station</strong> – str, station ID</p></li>
<li><p><strong>print_info</strong> – bool, print information or not</p></li>
<li><p><strong>isd_source</strong> – str, source of the ISD data</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>pandas dataframe</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="obswx.obswx.obswx.get_location">
<span class="sig-name descname"><span class="pre">get_location</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lat</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">tuple</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">tuple</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#obswx.obswx.obswx.get_location" title="Permalink to this definition"></a></dt>
<dd><p>Get location of the station</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>lat</strong> – int or float, latitude; list or tuple, latitude range</p></li>
<li><p><strong>lon</strong> – int or float, longitude; list or tuple, longitude range</p></li>
<li><p><strong>radius</strong> – int or float, distance in km</p></li>
<li><p><strong>source</strong> – str, source of the data</p></li>
<li><p><strong>ellipsoid</strong> – str, ellipsoid. Default is “WGS-84”, Check geopy.distance.geodesic for more options. ref: <a class="reference external" href="https://geopy.readthedocs.io/en/stable/#module-geopy.distance">https://geopy.readthedocs.io/en/stable/#module-geopy.distance</a></p></li>
<li><p><strong>year</strong> – int, list, tuple, year of the data or range of the year</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>pandas dataframe</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="obswx.obswx.obswx.get_meta">
<span class="sig-name descname"><span class="pre">get_meta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#obswx.obswx.obswx.get_meta" title="Permalink to this definition"></a></dt>
<dd><p>Get metadata</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>source</strong> – str, source of the data</p></li>
<li><p><strong>load</strong> – bool, load data or not</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>pandas dataframe</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
<section id="other-modules">
<h2>other modules<a class="headerlink" href="#other-modules" title="Permalink to this heading"></a></h2>
<section id="module-obswx.utils">
<span id="other-modules"></span><h2>other modules<a class="headerlink" href="#module-obswx.utils" title="Permalink to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="obswx.utils.read_hadisd">
<span class="sig-prename descclassname"><span class="pre">obswx.utils.</span></span><span class="sig-name descname"><span class="pre">read_hadisd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#obswx.utils.read_hadisd" title="Permalink to this definition"></a></dt>
<dd><p>Read HadISD data from a file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<em>str</em>) – Path to the file.</p></li>
<li><p><strong>output</strong> (<em>str</em>) – Path to the output file.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</section>
</section>

Expand Down
145 changes: 145 additions & 0 deletions py-modindex.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &mdash; obswx v0.0.0 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" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=f3b75425"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />



</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html" class="icon icon-home">
obswx
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Overview</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notebook/overview.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebook/overview.html#installation">Installation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tutorial</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notebook/UK_climate.html">UK monthly historical station data</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebook/HadISD.html">HadISD</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebook/ISD.html">ISD (AWS and NOAA)</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebook/location.html">ISD data with location, distance and time</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">obswx</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">obswx</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Python Module Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">


<h1>Python Module Index</h1>

<div class="modindex-jumpbox">
<a href="#cap-o"><strong>o</strong></a>
</div>

<table class="indextable modindextable">
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-o"><td></td><td>
<strong>o</strong></td><td></td></tr>
<tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
<code class="xref">obswx</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="obswx.html#module-obswx.obswx"><code class="xref">obswx.obswx</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="obswx.html#module-obswx.utils"><code class="xref">obswx.utils</code></a></td><td>
<em></em></td></tr>
</table>


</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, Junjie Yu, Zhonghua Zheng.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit d28f770

Please sign in to comment.