Skip to content

Commit

Permalink
Deploy to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] authored Oct 30, 2024
0 parents commit cf28071
Show file tree
Hide file tree
Showing 65 changed files with 10,133 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +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: b91813fa1201a767cc40d0635dfb4bee
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/changelog.doctree
Binary file not shown.
Binary file added .doctrees/contributing.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/installation.doctree
Binary file not shown.
Binary file added .doctrees/license.doctree
Binary file not shown.
Binary file added .doctrees/reference.doctree
Binary file not shown.
Binary file added .doctrees/reference/compas_mrr.arbitrary_pts_localization.doctree
Binary file not shown.
Binary file added .doctrees/reference/compas_mrr.doctree
Binary file not shown.
Binary file added .doctrees/reference/compas_mrr.measurement_point.doctree
Binary file not shown.
Binary file added .doctrees/reference/compas_mrr.three_pts_localization.doctree
Binary file not shown.
Binary file added .doctrees/reference/compas_mrr.utils.doctree
Binary file not shown.
Binary file added .doctrees/reference/compas_mrr.xforms.doctree
Binary file not shown.
Binary file added .doctrees/usage.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
375 changes: 375 additions & 0 deletions _modules/compas_mrr.html

Large diffs are not rendered by default.

563 changes: 563 additions & 0 deletions _modules/compas_mrr/arbitrary_pts_localization.html

Large diffs are not rendered by default.

336 changes: 336 additions & 0 deletions _modules/compas_mrr/measurement_point.html

Large diffs are not rendered by default.

315 changes: 315 additions & 0 deletions _modules/compas_mrr/three_pts_localization.html

Large diffs are not rendered by default.

366 changes: 366 additions & 0 deletions _modules/compas_mrr/utils.html

Large diffs are not rendered by default.

365 changes: 365 additions & 0 deletions _modules/compas_mrr/xforms.html

Large diffs are not rendered by default.

265 changes: 265 additions & 0 deletions _modules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,265 @@
<!DOCTYPE html>
<html lang="en">

<head>

<title>compas_mrr - Overview: module code</title>


<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />

<meta name="author" content="" />
<meta name="description" content="" />

<link rel="shortcut icon" href="../_static/images/compas.ico" type="image/x-icon">
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.0/css/all.css" integrity="sha384-lZN37f5QGtY3VHgisS14W3ExzMWZxybE1SJSEsQp9S+oqd12jhcu+A56Ebc1zFSJ" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/styles/mono-blue.min.css">
<link rel="stylesheet" type="text/css" href="../_static/css/compas.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/compas-reference.css" />





<script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script>
</head>

<body data-spy="scroll" data-target="#compas-toc">
<!-- header -->
<header id="header" class="compas-header d-flex align-items-center">
<nav class="navbar navbar-expand navbar-dark col flex-column flex-md-row text-center">
<!-- brand -->
<a class="navbar-brand" href="https://gramaziokohler.github.io/compas_mrr">
<img src="../_static/images/compas_icon_white.png" alt="COMPAS Mobile Robot Relocalization" width="48px" height="48px" />
</a>
<!-- brand -->
<!-- primary -->
<ul class="navbar-nav">
<li class="nav-item active"><a class="nav-link" href="https://gramaziokohler.github.io/compas_mrr">COMPAS Mobile Robot Relocalization</a></li>
</ul>
<!-- primary -->
<ul class="navbar-nav d-none d-md-flex ml-md-auto">
<!-- version -->

<!-- version -->
<!-- social -->
<li class="nav-item">
<a class="nav-link" href="https://github.com/gramaziokohler/compas_mrr" target="_blank">
<span class="fab fa-github fa-1x"></span>
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="http://forum.compas-framework.org" target="_blank">
<span class="fab fa-discourse fa-1x"></span>
</a>
</li>
<!-- social -->
</ul>
</nav>
</header>
<!-- header -->
<!-- main -->
<div class="container-fluid">
<div class="row">
<!-- main -->
<main class="col-12 col-md-9 col-xl-7 px-4 px-md-5 pt-2 pb-5 compas-content" role="main">

<nav aria-label="breadcrumb">
<ol class="breadcrumb mb-3 bg-white px-0">
<li class="breadcrumb-item"><a href="../index.html">COMPAS Mobile Robot Relocalization</a></li>

<!-- <li class="breadcrumb-item active" aria-current="page">Overview: module code</li> -->
</ol>
</nav>




<h1>All modules for which code is available</h1>
<ul><li><a href="compas_mrr.html">compas_mrr</a></li>
<ul><li><a href="compas_mrr/arbitrary_pts_localization.html">compas_mrr.arbitrary_pts_localization</a></li>
<li><a href="compas_mrr/measurement_point.html">compas_mrr.measurement_point</a></li>
<li><a href="compas_mrr/three_pts_localization.html">compas_mrr.three_pts_localization</a></li>
<li><a href="compas_mrr/utils.html">compas_mrr.utils</a></li>
<li><a href="compas_mrr/xforms.html">compas_mrr.xforms</a></li>
</ul></ul>

</main>
<!-- content -->
<!-- sidebar -->
<div class="col-12 col-md-3 compas-sidebar" role="navigation">
<form id="search" class="d-flex align-items-center compas-searchbox" action="../search.html" method="get">
<input class="form-control" type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
<button class="navbar-toggler d-md-none" type="button" data-toggle="collapse" data-target="#compas-navigation" aria-controls="compas-navigation" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
</form>


<div id="compas-navigation" class="collapse compas-navigation">
<ul class="nav flex-column collapse">
<li class="toctree-l1 nav-item"><a class="nav-link reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1 nav-item"><a class="nav-link reference internal" href="../usage.html">Usage</a></li>
<li class="toctree-l1 nav-item"><a class="nav-link reference internal" href="../reference.html">API reference</a><ul class="nav flex-column collapse">
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.three_pts_localization.html"><code class="docutils literal notranslate"><span class="pre">three_pts_localization()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.arbitrary_pts_localization.html">Arbitrary points method for robot relocalization.</a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.arbitrary_pts_localization.html#compas_mrr.arbitrary_pts_localization.arbitrary_pts_localization"><code class="docutils literal notranslate"><span class="pre">arbitrary_pts_localization()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.xforms.html"><code class="docutils literal notranslate"><span class="pre">worldxy_to_robot_base_xform()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.xforms.html#compas_mrr.xforms.xform_to_xyz_quaternion"><code class="docutils literal notranslate"><span class="pre">xform_to_xyz_quaternion()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.utils.html"><code class="docutils literal notranslate"><span class="pre">rgpoint_to_cgpoint()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.utils.html#compas_mrr.utils.cgpoint_to_rgpoint"><code class="docutils literal notranslate"><span class="pre">cgpoint_to_rgpoint()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.utils.html#compas_mrr.utils.cgframe_to_rgplane"><code class="docutils literal notranslate"><span class="pre">cgframe_to_rgplane()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.utils.html#compas_mrr.utils.rgtransform_to_cgtransformation"><code class="docutils literal notranslate"><span class="pre">rgtransform_to_cgtransformation()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.utils.html#compas_mrr.utils.rgtransform_to_matrix"><code class="docutils literal notranslate"><span class="pre">rgtransform_to_matrix()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.utils.html#compas_mrr.utils.cgtransformation_to_rgtransform"><code class="docutils literal notranslate"><span class="pre">cgtransformation_to_rgtransform()</span></code></a></li>
<li class="toctree-l2 nav-item"><a class="nav-link reference internal" href="../reference/compas_mrr.utils.html#compas_mrr.utils.matrix_to_rgtransform"><code class="docutils literal notranslate"><span class="pre">matrix_to_rgtransform()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1 nav-item"><a class="nav-link reference internal" href="../contributing.html">Contributing</a></li>
<li class="toctree-l1 nav-item"><a class="nav-link reference internal" href="../changelog.html">Changelog</a></li>
<li class="toctree-l1 nav-item"><a class="nav-link reference internal" href="../license.html">License</a></li>
</ul>

</div>

</div>
<!-- sidebar -->
<!-- toc -->
<div class="d-none d-xl-block col-xl-2 compas-toc" role="toc">


</div>
<!-- toc -->
</div>
</div>
<!-- main -->
<!-- footer -->
<footer class="compas-footer">
<nav class="nav p-2">



</nav>
</footer>
<!-- footer -->
<!-- below -->
<div class="below py-5" style="background-color: #222;">
<div class="container">
<div class="row flex-column">
<div class="col-12 col-md-6 mx-md-auto text-center">
<h4 class="pb-3 below-text">COMPAS</h4>
<p class="below-text">
A computational framework for collaboration and research
in Architecture, Engineering, Fabrication, and Construction.
</p>
<nav class="nav justify-content-center pb-3">
<a class="nav-link mx-2 px-0 below-link" href="http://github.com/compas-dev" target="_blank">
<span class="fab fa-github fa-1x"></span>
</a>
<a class="nav-link mx-2 px-0 below-link" href="http://forum.compas-framework.org" target="_blank">
<span class="fab fa-discourse fa-1x"></span>
</a>
<a class="nav-link mx-2 px-0 below-link" href="https://pypi.org/project/COMPAS/" target="_blank">
<span class="fab fa-python fa-1x"></span>
</a>
</nav>
</div>
</div>
<div class="row">
<div class="col text-center">
<p class="p-0 m-0 below-text">Copyright &copy; 2017-2021 compas-dev</p>
</div>
</div>
</div>
</div>
<!-- below -->
<!-- scripts -->
<script id="documentation_options" data-url_root="" src="../_static/documentation_options.js"></script>

<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.8/clipboard.min.js"></script>

<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/searchtools.js"></script>
<script src="../_static/language_data.js"></script>

<script>
$(document).ready(function () {
$(".language-default code").addClass("python");
$(".language-python code").addClass("python");
$(".language-bash code").addClass("bash");
$(".language-cpp code").addClass("cpp");
$(".language-json code").addClass("json");
$(".language-none code").addClass("plaintext");

hljs.initHighlighting();
anchors.add();

new ClipboardJS(".btn.copy", {
target: function(trigger) {
return trigger.nextElementSibling;
}
});

$("#compas-navigation li.active > ul").each(function() {
var ul = $(this);
if (! ul.hasClass("show")) {
ul.addClass("show");
}
});

$("#compas-navigation li.toctree-l1").has("ul").each(function() {
var li = $(this);
li.addClass("has-children");
if (li.hasClass("active")) {
li.prepend('<span class="menu-toggle"><i class="fas fa-chevron-up"></i></span>');
}
else {
li.prepend('<span class="menu-toggle"><i class="fas fa-chevron-down"></i></span>');
}
});

$(".menu-toggle").click(function() {
var toggle = $(this);
toggle.siblings("ul").toggleClass("show");
});

});


var url = $("#doc_versions").data("url");
var docs_site = $("#doc_versions").data("docs");

if (url) {
$.get(url, res => {
var lines = res.match(/[^\r\n]+/g);
lines.sort((a, b) => a.localeCompare(b, undefined, { numeric: true }));
lines.reverse();
lines.forEach(version => {
$("#doc_version_list").append("<a class=\"dropdown-item\" href=\"" + docs_site + version + "\">" + version + "</a>");
});

var selected_version = $('.nav-versions .dropdown-item').filter(function (i, ver) {
return window.location.href.startsWith(ver.href);
});
selected_version.addClass('active');
$("#bd-versions").text(selected_version.text());

})
}
</script>
<!-- scripts -->


</body>

</html>
1 change: 1 addition & 0 deletions _sources/changelog.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. mdinclude:: ../CHANGELOG.md
1 change: 1 addition & 0 deletions _sources/contributing.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. mdinclude:: ../CONTRIBUTING.md
33 changes: 33 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
==============================================================================
COMPAS Mobile Robot Relocalization
==============================================================================

Robot localization using external measuring device (total station).

Table of contents
-----------------

.. toctree::
:titlesonly:

installation
usage
reference
contributing
changelog
license

README
------

.. mdinclude:: ../README.md
:start-line: 5

.. image in README.md not rendered, see https://github.com/CrossNox/m2r2/issues/18 and 8
.. mdinclude:: ../CHANGELOG.md

License
-------

.. literalinclude:: ../LICENSE
44 changes: 44 additions & 0 deletions _sources/installation.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
*****************************************************************************
Installation
*****************************************************************************

Install
=======

#. Create a virtual environment using your tool of choice
(e.g. ``virtualenv`` or ``conda``) and install.

- Using `Anaconda <https://www.anaconda.com/>`__

.. code:: bash
conda config --add channels conda-forge
conda config --set channel_priority strict
conda create -n env_name python=3.8 compas_mrr
conda activate env_name
- Using `virtualenv <https://github.com/pypa/virtualenv>`__

.. code:: bash
virtualenv --python=python3.8 {{path/to/venv}}
source {{path/to/venv}}/bin/activate
pip install compas_mrr
#. Make package accessible in Rhino and Grasshopper

.. code:: bash
python -m compas_rhino.install
Update
======

To update the repository run:

.. code:: bash
# conda
conda update compas_mrr
# pip
pip install -U compas_mrr
4 changes: 4 additions & 0 deletions _sources/license.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
==============================================================================
License
==============================================================================
.. literalinclude:: ../LICENSE
12 changes: 12 additions & 0 deletions _sources/reference.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*****************************************************************************
API reference
*****************************************************************************

.. toctree::
:maxdepth: 1
:titlesonly:

reference/compas_mrr.three_pts_localization
reference/compas_mrr.arbitrary_pts_localization
reference/compas_mrr.xforms
reference/compas_mrr.utils
4 changes: 4 additions & 0 deletions _sources/reference/compas_mrr.arbitrary_pts_localization.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. automodule:: compas_mrr.arbitrary_pts_localization
:members:
:undoc-members:
:show-inheritance:
4 changes: 4 additions & 0 deletions _sources/reference/compas_mrr.measurement_point.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. automodule:: compas_mrr.measurement_point
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit cf28071

Please sign in to comment.