Skip to content
This repository has been archived by the owner on Oct 19, 2021. It is now read-only.

An vacuum intelligent agent created for a AI course.

Notifications You must be signed in to change notification settings

killian-mahe/agent-aspirateur

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Vacuum Agent

An vacuum intelligent agent created for the course of AI at UQAC.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

The goal of this project was to create a vacuum agent that will must clean all the room of a hotel.

Subject

You have a large mansion with many rooms that are constantly getting dirty. Since your maintenance workers have joined a union, they've been asking to work terrible hours (8 to 16, you guessed it!) and to get breaks during the day. Too bad for them! You decide to order an Aspirobot T-0.1 to replace all these lazy people. After all, the company guaranteed that it would avoid vacuuming your expensive jewellery (it would be sad to lose a $15,000 diamond for a bit of dust) and that it would automatically keep a maximum of rooms clean at all times without wasting electricity!

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Getting Started

This project is based on Python. No framework is needed, but you must install the PyQt5 package. We strongly suggest your to create a virtual environment to create the app environment.

Installation

Before clonning the repository, you should create a new virtual environment (using venv for exemple).

  1. Clone the project
    git clone https://github.com/killian-mahe/agent-aspirateur.git
  2. Install virtual environment
    cd agent-aspirateur && python3 -m venv env
  3. Activate the new environment
    source env/bin/activate
  4. Install required packages
    pip install -r /path/to/requirements.txt

Use

  1. Start the project
    python vacuum-agent

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Killian Mahé - @killian-mahe - [email protected]

Project Link: https://github.com/killian-mahe/agent-aspirateur

Acknowledgements

About

An vacuum intelligent agent created for a AI course.

Topics

Resources

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages