Skip to content

Commit

Permalink
doc: update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
mdeboute committed Oct 27, 2023
1 parent bf93364 commit af206f8
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ test = False # Whether to run the agent in test mode or not

You can also run the agent from a notebook using the `Launcher` class. See the [notebooks](notebooks) folder and the API documentation for more information.

## Development requirements

In order to develop the package, you need to install the required dependencies for development. Moreover, it is highly recommended to use a virtual environment.

```bash
pip install -r requirements/requirements.txt
```

## Building documentation

Documentation can be built using sphinx and by installing required dependencies.
Expand Down Expand Up @@ -89,11 +97,3 @@ chmod +x visualize.sh
```

Where `<g2op_env_path>` is the path to the environment data directory stored by [Grid2Op](https://github.com/rte-france/Grid2Op) (stored in a folder called "`data_grid2op`").

## Development requirements

In order to develop the package, you need to install the required dependencies for development. Moreover, it is highly recommended to use a virtual environment.

```bash
pip install -r requirements/requirements.txt
```

0 comments on commit af206f8

Please sign in to comment.