Skip to content

Commit d08bcfa

Browse files
Merge pull request #5 from ika-rwth-aachen/improve/readme
Add more information to readme
2 parents e6a1241 + b41d09a commit d08bcfa

File tree

2 files changed

+37
-21
lines changed

2 files changed

+37
-21
lines changed

README.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,52 @@
33
[![Build Main](https://github.com/ika-rwth-aachen/acdc-notebooks/actions/workflows/build.yml/badge.svg)](https://github.com/ika-rwth-aachen/acdc-notebooks/actions/workflows/build.yml)
44

55

6-
This repository belongs to the MOOC [Automated and Connected Driving Challenges (ACDC)](https://www.edx.org/course/automated-and-connected-driving-challenges). It contains Jupyter Notebook programming assignments. Enroll in the MOOC to get access to the solutions.
6+
# Automated and Connected Driving Challenges (ACDC)
77

8+
This repository belongs to the **Automated and Connected Driving Challenges (ACDC)**, a Massive Open Online Course (MOOC) on [edX.org](https://www.edx.org/course/automated-and-connected-driving-challenges), teaching how to solve current challenges in the field of automated and connected mobility. This repository contains Jupyter Notebook programming tasks.
89

9-
## Start of the Assignments: [index.ipynb](index.ipynb)
10+
Watch the **Course Trailer** for a quick introduction to the course:
1011

11-
__Note that the Jupyter Notebooks are sometimes not correctly displayed on Github (Missing Images).__
12+
[![Watch the video](assets/ACDC_YT_Thumbnail.png)](https://www.youtube.com/watch?v=XR2uBMVX1As)
1213

13-
__Use JuypterLab to display the notebooks.__
14+
**Enroll** in the course **for free** [here](https://www.edx.org/course/automated-and-connected-driving-challenges) and learn how to shape future automated and connected mobility!
1415

16+
The course is taught by the [Institute for Automotive Engineering (ika)](https://www.ika.rwth-aachen.de/) of [RWTH Aachen University](https://rwth-aachen.de) in Germany.
1517

16-
## Instructions to start JupyterLab with the Jupyter Notebooks using Docker
17-
Docker should be used for starting JupyterLab on you local machine. You can use the following instructions to run the system:
18+
## Repository Content
1819

19-
You can either build the docker image
20-
```bash
21-
./docker_build.sh
22-
```
20+
For the complete course content including the solutions to all programming tasks in the course, please enroll in the course.
2321

24-
or pull it from our registry (recommended):
25-
```bash
26-
docker pull rwthika/acdc-notebooks:latest
27-
```
22+
If you want to get to know the programming tasks of this repository, you can find an overview in this [Jupyter Notebook](index.ipynb).
2823

29-
Then navigate to `acdc-notebooks/docker` and run `./run.sh`.
30-
```bash
31-
./run.sh
32-
```
24+
We offer additional programming tasks relating to the [Robot Operating System (ROS)]((https://ros.org/)) in the [ACDC repository](https://github.com/ika-rwth-aachen/acdc).
3325

34-
The docker image should start now and your terminal should display some output. Open the last link displayed in the terminal and JupyterLab will open in your browser.
26+
**Note** that Jupyter Notebooks are often not correctly displayed on Github. Use [JuypterLab](https://jupyter.org/) as described below to correctly display the notebooks.
3527

36-
![](assets/terminal.png)
28+
## Quick Start
3729

38-
Navigate to the `/acdc/` directory in JupyterLab and open `index.ipynb` to get an overview of all available notebooks.
30+
All programming tasks can be run inside of a Docker container, which we provide. Our ACDC-Notebooks Docker container can be used for starting JupyterLab on you local machine. You can use the following instructions to run the container:
31+
32+
0. Follow all steps described under [Installation](https://github.com/ika-rwth-aachen/acdc/wiki#installations) in the ACDC repository's Wiki.
33+
34+
1. Clone this repository:
35+
```bash
36+
git clone https://github.com/ika-rwth-aachen/acdc-notebooks.git
37+
```
38+
39+
2. Pull our ACDC-Notebooks Docker image from our registry:
40+
```bash
41+
docker pull rwthika/acdc-notebooks:latest
42+
```
43+
44+
3. In a terminal, navigate to the Docker directory of this repository and launch the ACDC-Notebooks Docker container with the provided run script:
45+
```bash
46+
# acdc-notebooks/docker
47+
./run.sh
48+
```
49+
50+
The Docker image should start now and your terminal should display some output similar to the one seen in the image below. Open the last link displayed in *your* terminal and JupyterLab will open in your browser.
51+
52+
![](assets/terminal.png)
53+
54+
4. Navigate to the `/acdc/` directory in JupyterLab and open `index.ipynb` to get an overview of all available notebooks.

assets/ACDC_YT_Thumbnail.png

950 KB
Loading

0 commit comments

Comments
 (0)