Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
site

# Local design prototype (contains proprietary fonts, not meant to be published)
RoboStack Website/

# pixi environments
.pixi
*.egg-info
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,9 @@
# robostack.github.io

Source files for the [robostack.github.io](https://robostack.github.io/) website.

The site is built with [Zensical](https://zensical.org/) and has three
sections, linked from the common header:

- the frontpage - plain HTML in `overrides/home.html`, registered by `docs/index.md`
- the package page - plain HTML in `overrides/packages.html`, registered by `docs/packages/index.md`
- the documentation - the Markdown files in `docs/`

The header itself is the customized partial in `overrides/partials/header.html`:
the logo links to the frontpage, and the Packages and Documentation links sit
next to it.
Source files for the [robostack.github.io](https://robostack.github.io/) documentation website.

# Run it locally

```
pixi run serve
```

Open server on http://127.0.0.1:8000/
6 changes: 3 additions & 3 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot
rviz2
```

If you run into any issues or for any frequently asked questions, you can check the [FAQ page](FAQ.md)
If you run into any issues or for any frequently asked questions, you can check the [FAQ page](https://robostack.github.io/FAQ.html)

## Updating
Updating all packages in your environment is as easy as:
Expand Down Expand Up @@ -423,7 +423,7 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot
rviz2
```

If you run into any issues or for any frequently asked questions, you can check the [FAQ page](FAQ.md)
If you run into any issues or for any frequently asked questions, you can check the [FAQ page](https://robostack.github.io/FAQ.html)

## Updating
Updating all packages in your environment is as easy as:
Expand Down Expand Up @@ -479,7 +479,7 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot
rviz2
```

If you run into any issues or for any frequently asked questions, you can check the [FAQ page](FAQ.md)
If you run into any issues or for any frequently asked questions, you can check the [FAQ page](https://robostack.github.io/FAQ.html)

## Updating
Updating all packages in your environment is as easy as:
Expand Down
43 changes: 0 additions & 43 deletions docs/Overview.md

This file was deleted.

26 changes: 1 addition & 25 deletions docs/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,7 @@
border: 0;
}
.md-grid {
max-width: 1640px;
}

/* Section links (Packages, Documentation) inside the header bar */
.rs-header-links {
display: flex;
align-items: center;
gap: 1.2rem;
margin: 0 0.6rem;
white-space: nowrap;
}
.rs-header-links a {
color: currentColor;
font-size: 0.7rem;
opacity: 0.7;
transition: opacity 125ms;
}
.rs-header-links a:hover {
opacity: 1;
text-decoration: none;
}
@media screen and (max-width: 59.9844em) {
.rs-header-links {
display: none;
}
max-width: 1640px;
}


49 changes: 43 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,43 @@
---
template: home.html
hide:
- navigation
- toc
---
# RoboStack
Welcome to RoboStack - a bundling of the Robot Operating System (ROS) by Open Robotics for Linux, Mac and Windows using the Conda package manager. We provide ROS packages for ROS1 Noetic and ROS2 Humble (as well as unsupported Melodic/Foxy/Galactic packages), as well as a variety of ROS related plugins for Jupyter notebooks.

If you use RoboStack in an academic article, please cite the following [paper](https://arxiv.org/abs/2104.12910):
```BibTeX
@article{FischerRAM2021,
title={A RoboStack Tutorial: Using the Robot Operating System Alongside the Conda and Jupyter Data Science Ecosystems},
author={Tobias Fischer and Wolf Vollprecht and Silvio Traversaro and Sean Yen and Carlos Herrero and Michael Milford},
journal={IEEE Robotics and Automation Magazine},
year={2021},
doi={10.1109/MRA.2021.3128367},
}
```

## Why RoboStack?
- ROS on *any* platform: Linux (any distribution, new and old), MacOS and Windows
- Easy installation of ROS side-by-side with PyTorch, Tensorflow & many more (very recent) machine learning and computer vision algorithms in a Conda environment
- No root access required - install ROS on shared workstations & high-performance computers
- Reproducible environments and reproducible robotics research
- RViz-like visualizations in the browser *without* a ROS installation
- Control your robot in Jupyter notebooks & ROS integration with Jupyterlab
- Easy package creation - creating a Conda package is much easier than creating Debian packages
- Cross-platform CI for ROS packages
- ...

Here you can see RViz on Linux Fedora, MacOS and Windows:
![0*CWMpP2kGWulIQeHf](https://user-images.githubusercontent.com/5497832/129636748-67ece961-f762-4440-a95f-c097012fac3f.jpg)

## How to get started & install RoboStack?
See [Getting Started](https://robostack.github.io/GettingStarted.html)

## Which packages are available?
Please see the "Available Packages" links in the menu. If a package is not yet available for a given distribution/platforms, simply open a pull request and we will do our best to get it up any running.

## How to get involved?

We are very keen to involve more collaborators. Join us on the [`robotics` channel on `prefix.dev`'s discord](https://discord.gg/kKV8ZxyzY4) and check out our [Contribution guidelines](https://robostack.github.io/Contributing.html).

## Overview video
Check out our IROS 2022 presentation for a 7 minute teaser:
<div class="video-wrapper">
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/QJE9a1zCSRM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>
7 changes: 0 additions & 7 deletions docs/packages/index.md

This file was deleted.

201 changes: 0 additions & 201 deletions docs/static/colors_and_type.css

This file was deleted.

Loading