https://github.com/gabriel-milan/sailboat-playground

A very simple framework for developing autonomous sailing algorithms and testing them with 2D simulations/visualizations.
https://github.com/gabriel-milan/sailboat-playground

autonomous autonomous-vehicles framework sailboat simulation

Last synced: 4 months ago
JSON representation

A very simple framework for developing autonomous sailing algorithms and testing them with 2D simulations/visualizations.

• Host: GitHub
• URL: https://github.com/gabriel-milan/sailboat-playground
• Owner: gabriel-milan
• Created: 2021-04-03T15:47:01.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T07:57:51.000Z (almost 2 years ago)
• Last Synced: 2024-09-14T12:26:15.614Z (5 months ago)
• Topics: autonomous, autonomous-vehicles, framework, sailboat, simulation
• Language: Python
• Homepage:
• Size: 86.9 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Sailboat Playground

Language: [EN](#) (incomplete) / [PT-BR](README_br.md) (completo)

A very simple framework for developing autonomous sailing algorithms and testing them with 2D simulations/visualizations.

## Getting started

There are two ways to install this on your machine:

### Option #1 - From GitHub repository (recommended)

Using this method, you'll be able to execute the examples as they are, with no further changes required.

- Clone this repository

```

https://github.com/gabriel-milan/sailboat-playground

```

- `cd` into the cloned repository and install it

```

python3 -m pip install .

```

- And it's done! If you want to run the `upwind` example, do

```

python3 examples/upwind/sailing_upwind.py

```

### Option #2 - From PyPI

This package is also available on PyPI, but you'll need to create your own environment and boat configuration files before you use it.

- Install from PyPI:

```

python3 -m pip install sailboat_playground

```

## Basic usage

This framework is split in two main modules: `engine` and `visualization`.

The `engine` module handles the simulation and generates files with simulation data for later debugging and visualization. The main class of the engine is the `Manager` class. There, you need to provide both boat and environment configuration files

Work in progress... (will write this one in PT-BR first)