Skip to content

Simple drone control simulation that serves as API for more complex programs

License

Notifications You must be signed in to change notification settings

erlete/aerotech-simple-drone-control

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple Drone Control (SDC)

Python Test Execution PyPI release Coverage Status Python version

Simple drone control simulation that serves as API for more complex programs.

Important

This package has been developed with the sole purpose of serving as educational tool. It does not provide with real dynamic simulation models for drones nor tracks. However, it can be used to develop some initial ideas for autonomous drone flight algorithms, without having to deal with heavy constraints such as air drag, gravity, etc. Furthermore, since it has not been developed for external usage, multiple errors or inconsistencies might arise

Installation

This package has been released through PyPI, so it can be installed using Python's pip module:

python -m pip install --upgrade simple-drone-control

Note

The command above asumes that your Python interpreter is aliased to python and references a version equal to or greater than 3.10

Alternatively, it is also possible to clone this repository and use the package using pip and/or build.

Usage

The code snippet below shows all imports required to start developing a simulation. Take a look at this code skeleton example for a more detailed example.

import sdc  # Imports the whole package.

from sdc.core.vector import Vector3D, Rotator3D, distance3D  # Imports core functionality classes and functions.
from sdc.api.simulation import SimulationAPI  # Imports API simulation class.
from sdc.environment.reader import TrackSequenceReader  # Imports a reader class for track databases.

Warning

The package is installed as simple-drone-control, but imported as sdc. Attempting to import it using the installation name will result in an error

Contributions

This package has not been developed with expansion expectations, yet external feedback is always welcome, so feel free to drop your suggestions or error reports on the issues section.