Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add modal issue #57

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Add modal issue #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
85dfb78
Add modal issue
praffi-systemx Jul 7, 2022
6262705
Add recommandations table
praffi-systemx Jul 8, 2022
aa55fc6
Add to variant trees
praffi-systemx Jul 11, 2022
f81f1d0
Add running modes
praffi-systemx Jul 11, 2022
962a682
Apply recommandation
praffi-systemx Jul 12, 2022
2ddf139
Add simulate and integrate manual action
praffi-systemx Jul 13, 2022
423d0ea
Add simulate and integrate manual action callbacks
praffi-systemx Jul 13, 2022
8467290
Add simulate recommendation button
praffi-systemx Jul 18, 2022
6d8b919
Add Expert Assistance
praffi-systemx Jul 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,6 @@ g2op_env_customization.py
g2op_params.json
**/~$*.pptx
assistant_test/

# outputs of ExpertOp4Grid
*.csv
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ It allows human and possibly an "assistant" (aka an "agent", for example develop
## Disclaimer
This package is still in "early alpha" mode.

Performances are not that great and some useful features are still missing. The layout is also relatively "ugly"
Performances are not that great and some useful features are still missing. The layout is also relatively "ugly"
at the moment.


## Installation
To install the package, you need to install it from source:
```commandline
python3 -m pip install git+https://github.com/BDonnot/grid2game.git
```
```

An alternative is to clone the repository, and then install it from there:
```commandline
Expand All @@ -25,6 +25,12 @@ cd grid2game
python3 install -e .
```

To enable Expert Assistance, you need to install ExpertOp4Grid from source:
```commandline
python3 -m pip install https://github.com/marota/ExpertOp4Grid.git
```


**IMPORTANT** In all cases, we highly recommend to perform these modifications inside a python virtual environment (for example using `conda create -n grid2game_env; conda activate grid2game_env` or `python -m virtualenv grid2game_env; source/grid2game_env/bin/activate`).

**NOTE** It will install some dependencies and will require, in particular grid2op >= 1.6.4. The use of `lightsim2grid <https://github.com/BDonnot/lightsim2grid>`_ is also highly recommended.
Expand All @@ -42,7 +48,7 @@ grid2game --dev --env_name educ_case14_storage --is_test
- `--dev` specifies that the dash server will run in "dev" mode, we recommend you to use it
- `--env_name educ_case14_storage` specifies that the application will run the `educ_case14_storage`
environment
- `--is_test` specifies that the grid2op environment will be built with `test=True` (so in this
- `--is_test` specifies that the grid2op environment will be built with `test=True` (so in this
case `grid2op.make("educ_case14_storage", test=True))

You can also add more parameters:
Expand All @@ -56,10 +62,10 @@ You can also add more parameters:
assistant can be loaded after the interface is started.
- `--assistant_seed SEED` allows you to specify the seed used by your agent (for reproductibility)
Depending on how you agent is coded, this might not work. This only calls `your_agent.seed(SEED)`.
- `--g2op_param ./g2op_params.json` set of parameters used to update the environment (this should be compatible
- `--g2op_param ./g2op_params.json` set of parameters used to update the environment (this should be compatible
with `param.init_from_json` from grid2op)
- `--g2op_config ./g2op_env_customization.py` how to configure the grid2op environment, this file should contain
a dictionnary named `env_config` and it will be used to initialize the grid2Op environment with :
a dictionnary named `env_config` and it will be used to initialize the grid2Op environment with :
`env.make(..., **env_config)`

For example, a more complete command line would be:
Expand Down
Loading