Skip to content

Commit

Permalink
Deployed b36dd2b with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@Moustikitos
Moustikitos committed Apr 7, 2024
1 parent 1227659 commit 3672dfe
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 36 deletions.
4 changes: 2 additions & 2 deletions c-code/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">

<li class="nav-item" data-level="1"><a href="#epsglidesrc" class="nav-link">epsglide.src</a>
<li class="nav-item" data-level="1"><a href="#module-epsglidesrc" class="nav-link">Module epsglide.src</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#unit-objects" class="nav-link">Unit Objects</a>
<ul class="nav flex-column">
Expand Down Expand Up @@ -116,7 +116,7 @@
<div class="col-md-9" role="main">

<p><a id="epsglide.src"></a></p>
<h1 id="epsglidesrc">epsglide.src</h1>
<h1 id="module-epsglidesrc">Module epsglide.src</h1>
<p><a id="epsglide.src.Unit"></a></p>
<h2 id="unit-objects">Unit Objects</h2>
<pre><code class="language-python">class Unit(ctypes.Structure)
Expand Down
18 changes: 9 additions & 9 deletions dataset/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">

<li class="nav-item" data-level="1"><a href="#epsglidedataset" class="nav-link">epsglide.dataset</a>
<li class="nav-item" data-level="1"><a href="#module-epsglidedataset" class="nav-link">Module epsglide.dataset</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#datasetconnexionerror-objects" class="nav-link">DatasetConnexionError Objects</a>
<ul class="nav flex-column">
Expand Down Expand Up @@ -132,9 +132,9 @@
<div class="col-md-9" role="main">

<p><a id="epsglide.dataset"></a></p>
<h1 id="epsglidedataset">epsglide.dataset</h1>
<h1 id="module-epsglidedataset">Module epsglide.dataset</h1>
<p><a id="epsglide.dataset.DATA"></a></p>
<h4 id="data">DATA</h4>
<h4 id="epsglidedatasetdata">epsglide.dataset.DATA</h4>
<p>Path where json dataset are stored. On each EPSG dataset request, json data
are stored on this local path to allow introspection when needed and faster
execution.</p>
Expand Down Expand Up @@ -181,7 +181,7 @@ <h2 id="epsgelement-objects">EpsgElement Objects</h2>
implemented yet).</li>
</ul>
<p><a id="epsglide.dataset.EpsgElement.__repr__"></a></p>
<h4 id="__repr__">__repr__</h4>
<h3 id="epsgelement__repr__">EpsgElement.__repr__</h3>
<pre><code class="language-python">def __repr__()
</code></pre>
<p>Return a string representation of the <code>EpsgElement</code> object.</p>
Expand All @@ -191,7 +191,7 @@ <h4 id="__repr__">__repr__</h4>
<code>&lt;ClassName Code: Name&gt;</code>.</li>
</ul>
<p><a id="epsglide.dataset.EpsgElement.populate"></a></p>
<h4 id="populate">populate</h4>
<h3 id="epsgelementpopulate">EpsgElement.populate</h3>
<pre><code class="language-python">def populate()
</code></pre>
<p>Populate the EPSG dataset element. This method is meant to be
Expand All @@ -206,7 +206,7 @@ <h2 id="unit-objects">Unit Objects</h2>
<li><code>ratio</code> <em>float</em> - The ratio value of the unit.</li>
</ul>
<p><a id="epsglide.dataset.Unit.from_target"></a></p>
<h4 id="from_target">from_target</h4>
<h3 id="unitfrom_target">Unit.from_target</h3>
<pre><code class="language-python">def from_target(value: Union[int, float]) -&gt; float
</code></pre>
<p>Convert a value to the dataset specific unit.</p>
Expand All @@ -226,7 +226,7 @@ <h4 id="from_target">from_target</h4>
possible.</li>
</ul>
<p><a id="epsglide.dataset.Unit.to_target"></a></p>
<h4 id="to_target">to_target</h4>
<h3 id="unitto_target">Unit.to_target</h3>
<pre><code class="language-python">def to_target(value: Union[int, float]) -&gt; float
</code></pre>
<p>Convert a value to computation specific units.</p>
Expand Down Expand Up @@ -266,7 +266,7 @@ <h2 id="ellipsoid-objects">Ellipsoid Objects</h2>
including parameters related to its shape and size.</li>
</ul>
<p><a id="epsglide.dataset.Ellipsoid.populate"></a></p>
<h4 id="populate_1">populate</h4>
<h3 id="ellipsoidpopulate">Ellipsoid.populate</h3>
<pre><code class="language-python">def populate()
</code></pre>
<p>Populate the <code>Ellipsoid</code> object with necessary data.</p>
Expand All @@ -288,7 +288,7 @@ <h2 id="geodeticcoordrefsystem-objects">GeodeticCoordRefSystem Objects</h2>
data, including datum and transformation parameters.</li>
</ul>
<p><a id="epsglide.dataset.GeodeticCoordRefSystem.populate"></a></p>
<h4 id="populate_2">populate</h4>
<h3 id="geodeticcoordrefsystempopulate">GeodeticCoordRefSystem.populate</h3>
<pre><code class="language-python">def populate()
</code></pre>
<p>Populate the <code>GeodeticCoordRefSystem</code> object with necessary data.</p>
Expand Down
32 changes: 24 additions & 8 deletions epsglide/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,24 @@
<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">

<li class="nav-item" data-level="1"><a href="#epsglide" class="nav-link">epsglide</a>
<li class="nav-item" data-level="1"><a href="#module-epsglide" class="nav-link">Module epsglide</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#distance" class="nav-link">distance</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#destination" class="nav-link">destination</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#to_crs" class="nav-link">to_crs</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#to_wgs84" class="nav-link">to_wgs84</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#projectedcoordrefsystem-objects" class="nav-link">ProjectedCoordRefSystem Objects</a>
<ul class="nav flex-column">
</ul>
Expand All @@ -100,11 +116,11 @@
<div class="col-md-9" role="main">

<p><a id="epsglide"></a></p>
<h1 id="epsglide">epsglide</h1>
<h1 id="module-epsglide">Module epsglide</h1>
<p>This package aims to perform simple requests to <a href="https://apps.epsg.org/api/swagger/ui/index"><code>EPSG GeoRepository API</code></a> and provides associated geodesic
computation and map projection.</p>
<p><a id="epsglide.distance"></a></p>
<h4 id="distance">distance</h4>
<h2 id="distance">distance</h2>
<pre><code class="language-python">def distance(obj: dataset.Ellipsoid, start: Geodetic,
stop: Geodetic) -&gt; Vincenty_dist
</code></pre>
Expand All @@ -121,7 +137,7 @@ <h4 id="distance">distance</h4>
<li><code>Vincenty_dist</code> - The distance between the two points.</li>
</ul>
<p><a id="epsglide.destination"></a></p>
<h4 id="destination">destination</h4>
<h2 id="destination">destination</h2>
<pre><code class="language-python">def destination(obj: dataset.Ellipsoid, start: Geodetic,
dist: Vincenty_dist) -&gt; Vincenty_dest
</code></pre>
Expand All @@ -139,7 +155,7 @@ <h4 id="destination">destination</h4>
<li><code>Vincenty_dest</code> - The destination point.</li>
</ul>
<p><a id="epsglide.to_crs"></a></p>
<h4 id="to_crs">to_crs</h4>
<h2 id="to_crs">to_crs</h2>
<pre><code class="language-python">def to_crs(obj: dataset.GeodeticCoordRefSystem,
crs: dataset.GeodeticCoordRefSystem, lla: Geodetic) -&gt; Geodetic
</code></pre>
Expand All @@ -158,7 +174,7 @@ <h4 id="to_crs">to_crs</h4>
<li><code>Geodetic</code> - The converted coordinates.</li>
</ul>
<p><a id="epsglide.to_wgs84"></a></p>
<h4 id="to_wgs84">to_wgs84</h4>
<h2 id="to_wgs84">to_wgs84</h2>
<pre><code class="language-python">def to_wgs84(obj: dataset.GeodeticCoordRefSystem, lla: Geodetic) -&gt; Geodetic
</code></pre>
<p>Convert coordinates from a geodetic coordinate reference system to WGS84.</p>
Expand Down Expand Up @@ -197,13 +213,13 @@ <h2 id="projectedcoordrefsystem-objects">ProjectedCoordRefSystem Objects</h2>
<li><code>parameters</code> <em>list</em> - list of <code>dataset.CoordOperationParameter</code>.</li>
</ul>
<p><a id="epsglide.ProjectedCoordRefSystem.__call__"></a></p>
<h4 id="__call__">__call__</h4>
<h3 id="projectedcoordrefsystem__call__">ProjectedCoordRefSystem.__call__</h3>
<pre><code class="language-python">def __call__(
element: typing.Union[Geodetic, Geographic]
) -&gt; typing.Union[Geodetic, Geographic]
</code></pre>
<p><a id="epsglide.ProjectedCoordRefSystem.transform"></a></p>
<h4 id="transform">transform</h4>
<h3 id="projectedcoordrefsystemtransform">ProjectedCoordRefSystem.transform</h3>
<pre><code class="language-python">def transform(element: typing.Union[Geodetic, Geographic],
dest_crs) -&gt; Geographic
</code></pre></div>
Expand Down
24 changes: 12 additions & 12 deletions geodesy/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">

<li class="nav-item" data-level="1"><a href="#epsglidegeodesy" class="nav-link">epsglide.geodesy</a>
<li class="nav-item" data-level="1"><a href="#module-epsglidegeodesy" class="nav-link">Module epsglide.geodesy</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#geodetic-objects" class="nav-link">Geodetic Objects</a>
<ul class="nav flex-column">
Expand All @@ -100,7 +100,7 @@
<div class="col-md-9" role="main">

<p><a id="epsglide.geodesy"></a></p>
<h1 id="epsglidegeodesy">epsglide.geodesy</h1>
<h1 id="module-epsglidegeodesy">Module epsglide.geodesy</h1>
<p>Module for handling geodetic coordinates and their representations.</p>
<p>This module provides functionality for working with geodetic coordinates,
allowing for different representations and initialization methods.</p>
Expand Down Expand Up @@ -149,7 +149,7 @@ <h2 id="geodetic-objects">Geodetic Objects</h2>
<li><code>altitude</code> <em>float</em> - elevation of the geodetic coordinates in meters.</li>
</ul>
<p><a id="epsglide.geodesy.Geodetic.maidenhead"></a></p>
<h4 id="maidenhead">maidenhead</h4>
<h3 id="geodeticmaidenhead">Geodetic.maidenhead</h3>
<pre><code class="language-python">def maidenhead(level: int = 4) -&gt; str
</code></pre>
<p>Convert coordinates to maidenhead representation. Precision can be set
Expand All @@ -168,7 +168,7 @@ <h4 id="maidenhead">maidenhead</h4>
<li><code>str</code> - Maidenhead string.</li>
</ul>
<p><a id="epsglide.geodesy.Geodetic.from_maidenhead"></a></p>
<h4 id="from_maidenhead">from_maidenhead</h4>
<h3 id="geodeticfrom_maidenhead">Geodetic.from_maidenhead</h3>
<pre><code class="language-python">@staticmethod
def from_maidenhead(maidenhead: str)
</code></pre>
Expand All @@ -189,7 +189,7 @@ <h4 id="from_maidenhead">from_maidenhead</h4>
(6.510416666666665e-07, 6.510416666666665e-07)
</code></pre>
<p><a id="epsglide.geodesy.Geodetic.georef"></a></p>
<h4 id="georef">georef</h4>
<h3 id="geodeticgeoref">Geodetic.georef</h3>
<pre><code class="language-python">def georef(digit: int = 8) -&gt; str
</code></pre>
<p>Convert coordinates to georef. Best precision can be set with a
Expand All @@ -209,7 +209,7 @@ <h4 id="georef">georef</h4>
<li><code>str</code> - georef representation.</li>
</ul>
<p><a id="epsglide.geodesy.Geodetic.from_georef"></a></p>
<h4 id="from_georef">from_georef</h4>
<h3 id="geodeticfrom_georef">Geodetic.from_georef</h3>
<pre><code class="language-python">@staticmethod
def from_georef(georef: str)
</code></pre>
Expand All @@ -235,15 +235,15 @@ <h4 id="from_georef">from_georef</h4>
(8.333333333333333e-05, 8.333333333333333e-05)
</code></pre>
<p><a id="epsglide.geodesy.Geodetic.gars"></a></p>
<h4 id="gars">gars</h4>
<h3 id="geodeticgars">Geodetic.gars</h3>
<pre><code class="language-python">def gars() -&gt; str
</code></pre>
<p>Get the associated GARS Area (5minx5min tile).</p>
<pre><code class="language-python">&gt;&gt;&gt; dublin.gars()
'348MY16'
</code></pre>
<p><a id="epsglide.geodesy.Geodetic.from_gars"></a></p>
<h4 id="from_gars">from_gars</h4>
<h3 id="geodeticfrom_gars">Geodetic.from_gars</h3>
<pre><code class="language-python">@staticmethod
def from_gars(gars: str, anchor: str = &quot;&quot;)
</code></pre>
Expand All @@ -266,7 +266,7 @@ <h4 id="from_gars">from_gars</h4>
<p>Global precision of centered GARS coordinates is about <code>0.0833</code>
degrees in longitude ad latitude.</p>
<p><a id="epsglide.geodesy.Geodetic.geohash"></a></p>
<h4 id="geohash">geohash</h4>
<h3 id="geodeticgeohash">Geodetic.geohash</h3>
<pre><code class="language-python">def geohash(digit: int = 10,
base: str = &quot;0123456789bcdefghjkmnpqrstuvwxyz&quot;) -&gt; str
</code></pre>
Expand All @@ -286,7 +286,7 @@ <h4 id="geohash">geohash</h4>
<li><code>str</code> - geohash representation.</li>
</ul>
<p><a id="epsglide.geodesy.Geodetic.from_geohash"></a></p>
<h4 id="from_geohash">from_geohash</h4>
<h3 id="geodeticfrom_geohash">Geodetic.from_geohash</h3>
<pre><code class="language-python">@staticmethod
def from_geohash(geohash: str,
base: str = &quot;0123456789bcdefghjkmnpqrstuvwxyz&quot;,
Expand All @@ -311,7 +311,7 @@ <h4 id="from_geohash">from_geohash</h4>
(2.682209014892578e-06, 1.341104507446289e-06)
</code></pre>
<p><a id="epsglide.geodesy.Geodetic.url_load_location"></a></p>
<h4 id="url_load_location">url_load_location</h4>
<h3 id="geodeticurl_load_location">Geodetic.url_load_location</h3>
<pre><code class="language-python">def url_load_location(url, **kwargs)
</code></pre>
<p>Return a static map image data from map provider.</p>
Expand All @@ -338,7 +338,7 @@ <h4 id="url_load_location">url_load_location</h4>
<p><strong>Returns</strong>:</p>
<p>Image data as <code>bytes</code> (py3) or <code>str</code> (py2).</p>
<p><a id="epsglide.geodesy.Geodetic.dump_location"></a></p>
<h4 id="dump_location">dump_location</h4>
<h3 id="geodeticdump_location">Geodetic.dump_location</h3>
<pre><code class="language-python">def dump_location(name, url, **kwargs)
</code></pre>
<p>Dump a static map image from map provider into filesystem.</p>
Expand Down
9 changes: 5 additions & 4 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,9 @@
<div class="col-md-9" role="main">

<h1 id="python-epsglide-package">Python <code>epsglide</code> package</h1>
<p>This package aims to perform simple requests to <a href="https://apps.epsg.org/api/swagger/ui/index"><code>EPSG GeoRepository API</code></a> and provides associated geodesic computation and map projections.</p>
<p>This package aims to perform simple requests to <a href="https://apps.epsg.org/api/swagger/ui/index"><code>EPSG GeoRepository API</code></a> and use associated geodesic computation or map projections.</p>
<h2 id="epsg-dataset-requests-and-projection">EPSG dataset requests and projection</h2>
<p><code>epslide</code> provides several dataset classes to manage parameters and populate the toplevel class <code>ProjectedCoordRefSystem</code>. This toplevel class allow projection and contains other dataset classes to perform geodetic computations.</p>
<pre><code class="language-python">&gt;&gt;&gt; import math, epsglide
&gt;&gt;&gt; crs = epsglide.ProjectedCoordRefSystem(26730)
&gt;&gt;&gt; crs
Expand Down Expand Up @@ -145,8 +146,8 @@ <h2 id="great-circle-computation">Great circle computation</h2>
&lt;lon=-000d07m37.21800s lat=+051d31m6.96720s alt=0.0&gt;
</code></pre>
<h2 id="support-this-project">Support this project</h2>
<p><a href="https://liberapay.com/Toons/donate"><img alt="Liberapay receiving" src="https://img.shields.io/liberapay/goal/Toons?logo=liberapay" /></a>
<a href="https://paypal.me/toons"><img alt="Paypal me" src="https://img.shields.io/badge/PayPal-toons-00457C?logo=paypal&amp;logoColor=white" /></a>
<!-- [![Liberapay receiving](https://img.shields.io/liberapay/goal/Toons?logo=liberapay)](https://liberapay.com/Toons/donate) -->
<p><a href="https://paypal.me/toons"><img alt="Paypal me" src="https://img.shields.io/badge/PayPal-toons-00457C?logo=paypal&amp;logoColor=white" /></a>
<a href="https://github.com/Moustikitos/python-epsg/blob/master/docs/img/bc1q6aqr0hfq6shwlaux8a7ydvncw53lk2zynp277x.png"><img alt="Bitcoin" src="https://img.shields.io/badge/Donate-bc1q6aqr0hfq6shwlaux8a7ydvncw53lk2zynp277x-ff9900?logo=bitcoin" /></a></p></div>
</div>
</div>
Expand Down Expand Up @@ -231,5 +232,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>

<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-02-25 10:42:06.654326+00:00
Build Date UTC : 2024-04-07 15:20:47.239721+00:00
-->
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit 3672dfe

Please sign in to comment.