mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-01-13 00:28:01 -05:00
202 lines
10 KiB
HTML
202 lines
10 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Getting Started — PythonRobotics documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/plot_directive.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/dark_mode_css/general.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/dark_mode_css/dark.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/clipboard.min.js"></script>
|
||
<script src="_static/copybutton.js"></script>
|
||
<script src="_static/dark_mode_js/default_dark.js"></script>
|
||
<script src="_static/dark_mode_js/theme_switcher.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" />
|
||
<link rel="next" title="Introduction" href="modules/introduction.html" />
|
||
<link rel="prev" title="Welcome to PythonRobotics’s documentation!" href="index.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"> PythonRobotics
|
||
<img src="_static/icon.png" class="logo" alt="Logo"/>
|
||
</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" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-9612347954373886"
|
||
crossorigin="anonymous"></script>
|
||
<!-- PythonRoboticsDoc -->
|
||
<ins class="adsbygoogle"
|
||
style="display:block"
|
||
data-ad-client="ca-pub-9612347954373886"
|
||
data-ad-slot="1579532132"
|
||
data-ad-format="auto"
|
||
data-full-width-responsive="true"></ins>
|
||
<script>
|
||
(adsbygoogle = window.adsbygoogle || []).push({});
|
||
</script>
|
||
|
||
</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">Contents</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#what-is-this">What is this?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#how-to-use">How to use</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/introduction.html">Introduction</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/localization/localization.html">Localization</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/mapping/mapping.html">Mapping</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/slam/slam.html">SLAM</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/path_planning/path_planning.html">Path Planning</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/path_tracking/path_tracking.html">Path Tracking</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/arm_navigation/arm_navigation.html">Arm Navigation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/aerial_navigation/aerial_navigation.html">Aerial Navigation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/bipedal/bipedal.html">Bipedal</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/control/control.html">Control</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/utils/utils.html">Utilities</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules/appendix/appendix.html">Appendix</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="how_to_contribute.html">How To Contribute</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">PythonRobotics</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"></a> »</li>
|
||
<li>Getting Started</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="https://github.com/AtsushiSakai/PythonRobotics/blob/master/docs/getting_started_main.rst" class="fa fa-github"> Edit on GitHub</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="getting-started">
|
||
<span id="id1"></span><h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1>
|
||
<section id="what-is-this">
|
||
<h2>What is this?<a class="headerlink" href="#what-is-this" title="Permalink to this headline"></a></h2>
|
||
<p>This is an Open Source Software (OSS) project: PythonRobotics, which is a Python code collection of robotics algorithms.</p>
|
||
<p>The focus of the project is on autonomous navigation, and the goal is for beginners in robotics to understand the basic ideas behind each algorithm.</p>
|
||
<p>In this project, the algorithms which are practical and widely used in both academia and industry are selected.</p>
|
||
<p>Each sample code is written in Python3 and only depends on some standard modules for readability and ease of use.</p>
|
||
<p>It includes intuitive animations to understand the behavior of the simulation.</p>
|
||
<p>See this paper for more details:</p>
|
||
<ul class="simple">
|
||
<li><p>PythonRobotics: a Python code collection of robotics algorithms: <a class="reference external" href="https://arxiv.org/abs/1808.10703">https://arxiv.org/abs/1808.10703</a></p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="requirements">
|
||
<span id="id2"></span><h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://www.python.org/">Python 3.11.x</a></p></li>
|
||
<li><p><a class="reference external" href="https://numpy.org/">NumPy</a></p></li>
|
||
<li><p><a class="reference external" href="https://scipy.org/">SciPy</a></p></li>
|
||
<li><p><a class="reference external" href="https://matplotlib.org/">Matplotlib</a></p></li>
|
||
<li><p><a class="reference external" href="https://www.cvxpy.org/">cvxpy</a></p></li>
|
||
</ul>
|
||
<p>For development:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://docs.pytest.org/en/latest/">pytest</a> (for unit tests)</p></li>
|
||
<li><p><a class="reference external" href="https://github.com/pytest-dev/pytest-xdist">pytest-xdist</a> (for parallel unit tests)</p></li>
|
||
<li><p><a class="reference external" href="https://mypy-lang.org/">mypy</a> (for type check)</p></li>
|
||
<li><p><a class="reference external" href="https://www.sphinx-doc.org/en/master/index.html">sphinx</a> (for document generation)</p></li>
|
||
<li><p><a class="reference external" href="https://github.com/charliermarsh/ruff">ruff</a> (for code style check)</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="how-to-use">
|
||
<h2>How to use<a class="headerlink" href="#how-to-use" title="Permalink to this headline"></a></h2>
|
||
<ol class="arabic simple">
|
||
<li><p>Clone this repo and go into dir.</p></li>
|
||
</ol>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>>$ git clone https://github.com/AtsushiSakai/PythonRobotics.git
|
||
|
||
>$ cd PythonRobotics
|
||
</pre></div>
|
||
</div>
|
||
<ol class="arabic simple" start="2">
|
||
<li><p>Install the required libraries.</p></li>
|
||
</ol>
|
||
<p>using conda :</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>>$ conda env create -f requirements/environment.yml
|
||
</pre></div>
|
||
</div>
|
||
<p>using pip :</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>>$ pip install -r requirements/requirements.txt
|
||
</pre></div>
|
||
</div>
|
||
<ol class="arabic simple" start="3">
|
||
<li><p>Execute python script in each directory.</p></li>
|
||
<li><p>Add star to this repo if you like it 😃.</p></li>
|
||
</ol>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to PythonRobotics’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="modules/introduction.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2018-2021, Atsushi Sakai.</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> |