Skip to content

Commit

Permalink
deploy: 7dc7bc8
Browse files Browse the repository at this point in the history
  • Loading branch information
Kartik9250 committed Oct 16, 2023
1 parent 72e952f commit 429e5a1
Show file tree
Hide file tree
Showing 85 changed files with 721 additions and 207 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: 0444b353554e900c877dbe2f07545936
config: 974f70283d843519d47035e1189f2cef
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/markdown/ros/ros.doctree
Binary file not shown.
15 changes: 15 additions & 0 deletions _sources/markdown/ros/ROS_installation/ROS_index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
ROS 1 Installation
================
This section serves as an installation guide for setting up the ``ROS 1 noetic`` on both **Mac** and **Linux** operating systems.
``ROS`` is a widely used framework for developing robotics software.

This guide provides step-by-step instructions for installing ``ROS``, allowing developers and enthusiasts to get started
with building robotic applications.

Installation for:

.. toctree::
:maxdepth: 1

Linux <./installation.rst>
Mac <./installation_on_mac.rst>
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Installation
Configuration steps
-------------------

1. Adding environment variables: To Automatically add ROS environment
#. Adding environment variables: To Automatically add ROS environment
variables to your bash session every time a new shell (terminal) is
launched, enter the following commands (this step is similar as
adding environmental variable in windows):
Expand All @@ -60,7 +60,7 @@ Configuration steps
echo "source /opt/ros/noetic/setup.bash" >> ~/.bashrc
source ~/.bashrc
2. Initialize rosdep: Before you can use many ROS tools, you will need
#. Initialize rosdep: Before you can use many ROS tools, you will need
to initialize rosdep. rosdep enables you to easily install system
dependencies for source you want to compile and is required to run
some core components in ROS.
Expand Down
96 changes: 96 additions & 0 deletions _sources/markdown/ros/ROS_installation/installation_on_mac.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
ROS installation on mac
================

- This Document assumes that the reader has installed ``anaconda3``
make sure to install it before proceeding.
- There are tons of resources available on the Internet to get this
done.
- You can visit the `anaconda website <https://docs.anaconda.com/free/anaconda/install/mac-os.html>`__ for more details on anaconda installation.

Setting up ROS environment
-----------------------

Make an environment on your computer named ``ROS``
you can use any name but since we are makeing it to run ros we'll name it ``ROS``

.. code:: shell
conda create -n ROS python=3.9
- Now enter your ``ROS`` environment

.. code:: shell
conda activate ROS
- Now we'll add channels to our environment that is ``conda-forge`` and ``robostack``, we are adding conda forge for the package

.. code:: shell
conda config --add channels conda-forge
.. code:: shell
conda config --add channels robostack
- Set the ``conda`` channel priority to **strict**

.. code:: shell
conda config --add channel_priority strict
With this our initial setup is done

Installation
------------

1. Install ros-noetic into the environment

.. code:: shell
conda install ros-noetic-desktop-full
2. Now we'll install compilers for our ``ros``

.. code:: shell
conda install compilers cmake pkg-config make ninja colcon-common-extensions catkin_tools
With this we are all set.

Testing the installation
------------------------

After installation you are able to run rviz and other ros tools.

In the ``conda`` environment activation is the ``ROS`` activation included. There is no need to add a source command in the ``~/.zshrc``. But there is a catch, that you'll have to run ``conda activate ROS`` command in every new instance of terminal.

First terminal

.. code:: shell
conda activate ROS
roscore
Second terminal

.. code:: shell
conda activate ROS
rviz
How to install ``ROS`` packages on mac
-----------------------------------------

Though we have installed the ros-noetic-desktop-full --version which comes with common built in packages like rviz, turtlesim and many more. There might be something specific you need so you'll need to search up the packag you're looking for `here <https://robostack.github.io/noetic.html>`__

If you've found what you were looking for then run this command and replace the package name with the one you want to install.

.. code:: shell
conda install ros-noetic-"package name here"
.. Note::
#. The ROS commands only work while you are in the ROS environment.
#. The packages available are a bit limited.

2 changes: 1 addition & 1 deletion _sources/markdown/ros/ros.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ package management.
:maxdepth: 4
:hidden:

./installation.rst
./ROS_installation/ROS_index.rst
./catkin_ws.rst
./package/package.rst
./node/node.rst
Expand Down
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.3.0',
VERSION: '0.3.2',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Index &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -14,7 +14,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=e259d695"></script>
<script src="_static/documentation_options.js?v=71d9d8e6"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>A.T.O.M’s Wiki ! &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>A.T.O.M’s Wiki ! &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=e259d695"></script>
<script src="_static/documentation_options.js?v=71d9d8e6"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/previous_tasks.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Previous Tasks &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Previous Tasks &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2021/hints.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Hints &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Hints &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2021/problem-statement.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Problem statement &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Problem statement &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2021/procedure.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Procedure &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Procedure &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2021/selection-task.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Selection Task 2021 &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Selection Task 2021 &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2021/submissions.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Submissions &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Submissions &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2022/hints.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Hints &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Hints &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2022/problem-statement.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Problem Statement &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Problem Statement &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2022/procedure.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Procedure &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Procedure &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2022/selection-task.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Selection Task 2022 &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Selection Task 2022 &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions markdown/archives/sel-task2022/submissions.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Submission Instruction &mdash; A.T.O.M&#39;s Wiki 0.3.0 documentation</title>
<title>Submission Instruction &mdash; A.T.O.M&#39;s Wiki 0.3.2 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/copybutton.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/documentation_options.js?v=71d9d8e6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
Loading

0 comments on commit 429e5a1

Please sign in to comment.