-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docker, and devcontainer documentation, update index in the process.
- Loading branch information
1 parent
dae7dd4
commit fb12f38
Showing
5 changed files
with
41 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
Container-based Development | ||
=========================== | ||
|
||
We strongly recommend development in the provided Docker container. The docker container | ||
is available from `DockerHub <https://hub.docker.com/repository/docker/lpaehler/hydrogym/general>`_ | ||
, and can be pulled with | ||
|
||
.. code-block:: console | ||
$ docker pull lpaehler/hydrogym:stable | ||
or directly run if one seeks to develop inside of it: | ||
|
||
.. code-block:: console | ||
$ docker run lpaehler/hydrogym:stable | ||
If `VSCode <https://code.visualstudio.com>`_ is used for development, a .devcontainer file is provided | ||
and allows VSCode to immediately spin up a `devcontainer <https://containers.dev>`_ with all dependencies | ||
installed. To make full use of this you have to have the | ||
`devcontainer extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers>`_ | ||
installed, and upon pointing VSCode at the HydroGym directory allow it to launch into the devcontainer. | ||
VSCode will then take care of the rest. | ||
|
||
.. note:: | ||
|
||
The first start of the devcontainer can take a minute depending on your internet connection as it needs to pull | ||
the docker container from the server before being able to launch the IDE into the container. | ||
|
||
For more information regarding the way devcontainer works please see | ||
`Microsoft's documentation <https://code.visualstudio.com/docs/devcontainers/containers>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
RLlib Integration | ||
================= | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
TorchRL Integration | ||
=================== | ||
|