Skip to content

Commit

Permalink
Deployed cf17693 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@Moustikitos
Moustikitos committed Feb 23, 2024
1 parent e99d9a1 commit 978eb78
Show file tree
Hide file tree
Showing 9 changed files with 3,029 additions and 7 deletions.
3 changes: 3 additions & 0 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
<li class="navitem">
<a href="/geodesy/" class="nav-link">Geodesy</a>
</li>
<li class="navitem">
<a href="/dataset/" class="nav-link">Dataset</a>
</li>
</ul>

<ul class="nav navbar-nav ml-auto">
Expand Down
304 changes: 304 additions & 0 deletions dataset/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,304 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">



<link rel="shortcut icon" href="../img/favicon.ico">
<title>Dataset - The EPSGlide Project</title>
<link href="../css/bootstrap.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
<link href="../style.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/python.min.js"></script>
<script>hljs.highlightAll();</script>
</head>

<body>
<div class="navbar fixed-top navbar-expand-lg navbar-light bg-light">
<div class="container">
<a class="navbar-brand" href="..">The EPSGlide Project</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
<span class="navbar-toggler-icon"></span>
</button>

<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="navitem">
<a href=".." class="nav-link">Home</a>
</li>
<li class="navitem">
<a href="../epsglide/" class="nav-link">EPSGlide</a>
</li>
<li class="navitem">
<a href="../geodesy/" class="nav-link">Geodesy</a>
</li>
<li class="navitem active">
<a href="./" class="nav-link">Dataset</a>
</li>
</ul>

<ul class="nav navbar-nav ml-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../geodesy/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" class="nav-link disabled">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/Moustikitos/python-epsg/edit/master/docs/dataset.md" class="nav-link"><i class="fa fa-github"></i> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
</div>

<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>


<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>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#epsgelement-objects" class="nav-link">EpsgElement Objects</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#ellipsoid-objects" class="nav-link">Ellipsoid Objects</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#geodeticcoordrefsystem-objects" class="nav-link">GeodeticCoordRefSystem Objects</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">

<p><a id="epsglide.dataset"></a></p>
<h1 id="epsglidedataset">epsglide.dataset</h1>
<p><a id="epsglide.dataset.EpsgElement"></a></p>
<h2 id="epsgelement-objects">EpsgElement Objects</h2>
<pre><code class="language-python">class EpsgElement(object)
</code></pre>
<p>Represents an EPSG dataset element.</p>
<p><strong>Attributes</strong>:</p>
<ul>
<li><code>_struct_</code> <em>ctypes.Structure</em> - object representing the structure of the
equivalant C element.</li>
</ul>
<p><strong>Arguments</strong>:</p>
<ul>
<li><code>code</code> <em>int</em> - the EPSG code of the element.</li>
<li><code>name</code> <em>str</em> - the name of the element.</li>
</ul>
<p><strong>Raises</strong>:</p>
<ul>
<li><code>DatasetIdentificationError</code> - if either EPSG code or name is not
provided.</li>
<li><code>NotImplementedError</code> - if searching by keyword is attempted (not
implemented yet).</li>
</ul>
<p><a id="epsglide.dataset.EpsgElement.__repr__"></a></p>
<h4 id="__repr__">__repr__</h4>
<pre><code class="language-python">def __repr__()
</code></pre>
<p>Return a string representation of the <code>EpsgElement</code> object.</p>
<p><strong>Returns</strong>:</p>
<ul>
<li><code>str</code> - a string representation of the object in the format
<code>&lt;ClassName Code: Name&gt;</code>.</li>
</ul>
<p><a id="epsglide.dataset.EpsgElement.populate"></a></p>
<h4 id="populate">populate</h4>
<pre><code class="language-python">def populate()
</code></pre>
<p>Populate the EPSG dataset element. This method is meant to be
overridden by subclasses.</p>
<p><a id="epsglide.dataset.EpsgElement.to_target"></a></p>
<h4 id="to_target">to_target</h4>
<pre><code class="language-python">def to_target(value: Union[int, float]) -&gt; float
</code></pre>
<p>Convert a value to the target unit, if applicable, ie: the
<code>EpsgElement</code> must contain a <code>Unit</code> class as attribute.</p>
<p><strong>Arguments</strong>:</p>
<ul>
<li><code>value</code> <em>int|float</em> - the value to be converted.</li>
</ul>
<p><strong>Returns</strong>:</p>
<ul>
<li><code>float|None</code> - the converted value, or None if no conversion is
possible.</li>
</ul>
<p><a id="epsglide.dataset.EpsgElement.from_target"></a></p>
<h4 id="from_target">from_target</h4>
<pre><code class="language-python">def from_target(value: Union[int, float]) -&gt; float
</code></pre>
<p>Convert a value from the target unit, if applicable, ie: the
<code>EpsgElement</code> must contain a <code>Unit</code> class as attribute.</p>
<p><strong>Arguments</strong>:</p>
<ul>
<li><code>value</code> <em>int|float</em> - the value to be converted.</li>
</ul>
<p><strong>Returns</strong>:</p>
<ul>
<li><code>float|None</code> - the converted value, or None if no conversion is
possible.</li>
</ul>
<p><a id="epsglide.dataset.Ellipsoid"></a></p>
<h2 id="ellipsoid-objects">Ellipsoid Objects</h2>
<pre><code class="language-python">class Ellipsoid(EpsgElement)
</code></pre>
<p>Represents an ellipsoid model used in geodetic coordinate reference
systems.</p>
<p><strong>Methods</strong>:</p>
<ul>
<li><code>populate</code> - Populate the <code>Ellipsoid</code> object with necessary data,
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>
<pre><code class="language-python">def populate()
</code></pre>
<p>Populate the <code>Ellipsoid</code> object with necessary data.</p>
<p>This method initializes the internal structure (<code>_struct_</code>) of the
<code>Ellipsoid</code> object with information about its semi-major axis,
semi-minor axis, flattening, eccentricity, and other related
parameters.</p>
<p>The initialization process depends on whether the ellipsoid&rsquo;s
inverse flattening is provided or calculated from its semi-major
and semi-minor axes.</p>
<p><a id="epsglide.dataset.GeodeticCoordRefSystem"></a></p>
<h2 id="geodeticcoordrefsystem-objects">GeodeticCoordRefSystem Objects</h2>
<pre><code class="language-python">class GeodeticCoordRefSystem(EpsgElement)
</code></pre>
<p>Represents a geodetic coordinate reference system.</p>
<p><strong>Methods</strong>:</p>
<ul>
<li><code>populate</code> - Populate the GeodeticCoordRefSystem object with necessary
data, including datum and transformation parameters.</li>
</ul>
<p><a id="epsglide.dataset.GeodeticCoordRefSystem.populate"></a></p>
<h4 id="populate_2">populate</h4>
<pre><code class="language-python">def populate()
</code></pre>
<p>Populate the <code>GeodeticCoordRefSystem</code> object with necessary data.</p>
<p>This method initializes the internal structure (<code>_struct_</code>) of the
<code>GeodeticCoordRefSystem</code> object with information about the datum,
ellipsoid, prime meridian, and transformation parameters.</p>
<p><strong>Raises</strong>:</p>
<ul>
<li><code>DatasetNotFound</code> - If no transformation is found for the given
coordinate reference system (CRS) code.</li>
<li><code>DatumInitializationError</code> - If an unmanageable transformation
parameter is encountered during initialization.</li>
</ul></div>
</div>
</div>

<footer class="col-md-12">
<hr>
<p>Copyright &copy; 2024 THOORENS Bruno - BSD licence</p>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../js/jquery-3.6.0.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script>
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../js/base.js"></script>
<script src="../search/main.js"></script>

<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>

</body>
</html>
19 changes: 17 additions & 2 deletions epsglide/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
<li class="navitem">
<a href="../geodesy/" class="nav-link">Geodesy</a>
</li>
<li class="navitem">
<a href="../dataset/" class="nav-link">Dataset</a>
</li>
</ul>

<ul class="nav navbar-nav ml-auto">
Expand Down Expand Up @@ -113,13 +116,25 @@ <h2 id="projectedcoordrefsystem-objects">ProjectedCoordRefSystem Objects</h2>
</code></pre>
<p><strong>Attributes</strong>:</p>
<ul>
<li><code>Datum</code> <em>dataset.GeodeticCoordRefSystem</em> - geodetic reference system.</li>
<li><code>GeodeticCoordRefSystem</code> <em>dataset.GeodeticCoordRefSystem</em> - geodetic
reference system.</li>
<li><code>Conversion</code> <em>dataset.Conversion</em> - projection method and parameters.</li>
<li><code>CoordOperationMethod</code> <em>dataset.CoordOperationMethod</em> - projection
description.</li>
<li><code>CoordSystem</code> <em>dataset.CoordSystem</em> - 2D coordinate system and units.</li>
<li><code>parameters</code> <em>list</em> - list of <code>dataset.CoordOperationParameter</code>.</li>
</ul></div>
</ul>
<p><a id="epsglide.ProjectedCoordRefSystem.__call__"></a></p>
<h4 id="__call__">__call__</h4>
<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>
<pre><code class="language-python">def transform(element: typing.Union[Geodetic, Geographic],
dest_crs) -&gt; Geographic
</code></pre></div>
</div>
</div>

Expand Down
5 changes: 4 additions & 1 deletion geodesy/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
<li class="navitem active">
<a href="./" class="nav-link">Geodesy</a>
</li>
<li class="navitem">
<a href="../dataset/" class="nav-link">Dataset</a>
</li>
</ul>

<ul class="nav navbar-nav ml-auto">
Expand All @@ -55,7 +58,7 @@
</a>
</li>
<li class="nav-item">
<a rel="next" class="nav-link disabled">
<a rel="next" href="../dataset/" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
Expand Down
Binary file added img/bc1q6aqr0hfq6shwlaux8a7ydvncw53lk2zynp277x.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 978eb78

Please sign in to comment.