From fb71780563c3bd7cc475bbc2e21cf243e879595d Mon Sep 17 00:00:00 2001 From: Dominik Roth Date: Thu, 3 Oct 2024 23:33:20 +0200 Subject: [PATCH] Better optional dependency management --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ec1d924..6f78731 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ NuCon includes a preliminary Reinforcement Learning (RL) environment based on th To use you'll need to install the following packages: ```bash -pip install gymnasium numpy +pip install -e .[rl] # gymnasium numpy ``` ### RL Environment @@ -143,7 +143,7 @@ NuCon provides a built-in simulator to address the challenge of slow training ti To use you'll need to install the following packages: ```bash -pip install torch flask +pip install -e .[sim] # torch flask ``` ### Usage @@ -193,7 +193,7 @@ To address the challenge of unknown game dynamics, NuCon provides tools for coll To use you'll need to install the following packages: ```bash -pip install torch numpy +pip install -e .[model] # torch numpy ``` ### Usage: @@ -229,7 +229,7 @@ NuCon includes a test suite to verify its functionality and compatibility with t To run the tests: 1. Ensure the Nucleares game is running and accessible at http://localhost:8785/ (or update the URL in the test setup). -2. Install pytest: `pip install pytest` +2. Install pytest: `pip install pytest` (or `pip install -e .[dev]`) 3. Run the tests: ```bash pytest test/test_core.py @@ -268,7 +268,7 @@ What? Why would you wanna cite it? What are you even doing? To use you'll need to install the following packages: ```bash -pip install pillow +pip install -e .[drake] # pillow ``` ### Usage: