Skip to content
Snippets Groups Projects
Commit f6540587 authored by Florian Schröder's avatar Florian Schröder
Browse files

Update author information and documentation

Added Christoph Kowalski to AUTHORS.md and README.md. Removed Annika Österdiekhoff and Dominik Battefeld from setup.py author list. Updated CHANGELOG.md with new RL feature and cleaned up README.md formatting.
parent 27d78a86
No related branches found
No related tags found
1 merge request!110V1.2.0 changes
Pipeline #67795 passed
# Authors
- Florian Schröder - https://gitlab.ub.uni-bielefeld.de/florian.schroeder
- Fabian Heinrich - https://gitlab.ub.uni-bielefeld.de/fheinrich
- Annika Österdiekhoff - https://gitlab.ub.uni-bielefeld.de/annika
- Dominik Battefeld - https://gitlab.ub.uni-bielefeld.de/dominik.battefeld
- Fabian Heinrich - https://gitlab.ub.uni-bielefeld.de/fheinrich
- Florian Schröder - https://gitlab.ub.uni-bielefeld.de/florian.schroeder
- Christoph Kowalski - https://gitlab.ub.uni-bielefeld.de/ckowalski
......@@ -21,6 +21,7 @@
- Deterministic Order Generation, opt-in. Instead of random you can define a list of orders that will be generated
- thumbnails of layouts in pygame 2d debug modus
- Sequence Diagrams for understanding internal execution flow.
- Single-Agent Reinforcement Learning with stable-baselines3
### Changed
- Available orders are sorted now (always the same order for the recipe graphs)
......
......@@ -17,13 +17,11 @@ the [Documentation](https://scs.pages.ub.uni-bielefeld.de/cocosy/cooperative-cui
</div>
## Installation
You have two options to install the environment. Either clone it and install it locally or install it in your
site-packages.
You need a Python 3.10 or newer environment conda environment.
### Local Editable Installation
In your `repo`, `PyCharmProjects` or similar directory with the correct environment active:
```bash
......@@ -57,7 +55,6 @@ cooperative-cuisine gui -s localhost -sp 8080 -g localhost -gp 8000
You can start also several GUIs. The study server does the matchmaking.
### Library Installation
The correct environment needs to be active:
```bash
......@@ -65,27 +62,22 @@ pip install cooperative_cuisine@git+https://gitlab.ub.uni-bielefeld.de/scs/cocos
```
#### Run
You can now use the environment and/or simulator in your python code. Just by importing
it `import cooperative_cuisine`
## Configuration
The environment configuration is currently done with 3 config files + GUI configuration.
### Item Config
The item config defines which ingredients, cooking equipment and meals can exist and how meals and processed ingredients
can be cooked/created.
### Layout Config
You can define the layout of the kitchen via a layout file. The position of counters are based on a grid system, even
when the players do not move grid steps but continuous steps. Each character defines a different type of counter. Which
character is mapped to which counter is defined in the Environment config.
### Environment Config
The environment config defines how a level/environment is defined. Here, the available plates, meals, order and player
configuration is done.
......@@ -94,10 +86,12 @@ When starting a study, the study config holds all the information about the leve
orders should in appear in a random ordering or whether their schedule should be pre-defined.
### PyGame Visualization Config
Here the visualisation for all objects is defined. Reference the images or define a list of base shapes that represent
the counters, ingredients, meals and players.
## Reinforcement Learning
Single agent RL is done with [sb3](https://stable-baselines3.readthedocs.io/en/master/). You can find additional information in the corresponding folder, [here](cooperative_cuisine/reinforcement_learning/README.md).
## Troubleshooting
```cannot open shared object file: No such file or directory (search paths /usr/lib/x86_64-linux-gnu/dri:\$${ORIGIN}/dri:/usr/lib/dri, suffix _dri)```
......
......@@ -170,5 +170,6 @@ Preparing a tomato soup in the cooperative cuisine environment with a random cou
Preparing a salad in the cooperative cuisine environment with a random counter layout.
</p>
----
by Christoph Kowalski
......@@ -48,7 +48,7 @@ def package_files(directory):
extra_files = package_files('configs') + package_files('pygame_2d_vis')
setup(
author="Annika Österdiekhoff, Dominik Battefeld, Fabian Heinrich, Florian Schröder",
author="Florian Schröder, Fabian Heinrich",
author_email="florian.schroeder@uni-bielefeld.de",
python_requires=">=3.10",
classifiers=[
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment