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.

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

docs: Update README.md #452

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ For the most part the package is fairly self-contained Python, however there are
- Run `python3 -m venv ./.venv`
- Run `source ./.venv/bin/activate`
- Run `python3 -m pip install -r requirements.txt`
- Run `python3 -m pip install -r requirements-dev.txt`
- If you want to run reinforcement learning, additionally run:
- Run `python3 -m pip install -r requirements.txt`
- Download the binaries by running `python -m vega_sim.tools.load_binaries` within your Python environment.
- Run `make test` which checks all the python environment + vega imports are set up correctly, doesn't run Vega yet.
- Run `make test_integration` which checks that everything is set up correctly. Takes about 5 minutes.
TomMcL marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -48,7 +51,7 @@ For the most part the package is fairly self-contained Python, however there are
- Run `make` to automatically pull install dependencies
- If you have your own instances of the various service to run from elsewhere, you can skip this step
- Install the package into your local environment.
- The process for this will vary depending upon your package manager of choice. We provide here a full Poetry `pyproject.toml` and a `requirements.txt` which is derived from it. These are kept in sync through a check on all pull requests. You can [install Poetry here](https://python-poetry.org/docs/#installation) and get everything ready by running `poetry shell` and `poetry install` (or `poetry install --all-extras` to cover all optional extras too).
- The process for this will vary depending upon your package manager of choice. We provide here a full Poetry `pyproject.toml` and a `requirements.txt` which is derived from it. These are kept in sync through a check on all pull requests. You can [install Poetry here](https://python-poetry.org/docs/#installation) and get everything ready by running `poetry shell` and `poetry install` (or `poetry install --all-extras` to cover all optional extras too). If installing through pip, as above you should also install `requirements-dev.txt` and optionally `requirements-learning.txt`
- Run `make test` which checks all the python environment + vega imports are set up correctly, doesn't run Vega yet.
- Run `make test_integration` which checks that everything is set up correctly. Takes about 5 minutes.
TomMcL marked this conversation as resolved.
Show resolved Hide resolved
- You're good now.
Expand Down