Skip to content

Commit

Permalink
Update CI and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Sampreet committed Oct 14, 2024
1 parent a9f791d commit 66957b5
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/python-tox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
matrix:
os: [
ubuntu-latest,
macos-12,
macos-latest,
windows-latest,
]

Expand All @@ -29,7 +29,7 @@ jobs:
- name: Install package
run: pip install -e .

tox:
test:

runs-on: ubuntu-latest
strategy:
Expand Down
File renamed without changes.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The toolbox primarily relies on `gymnasium` (for single environments) and `stabl
All of its dependencies can be installed using:

```bash
conda install "numpy<2.0.0" scipy matplotlib tqdm gymnasium stable-baselines3
conda install "numpy<2.0.0" scipy matplotlib tqdm pillow pandas gymnasium stable-baselines3
```

Additionally, to avail the PyTorch or JAX backends, the latest version of these framework (for both CPU and GPU) should be installed (preferably in different `conda` environments) using in their official documentations: [PyTorch docs](https://pytorch.org/get-started/locally/) and [JAX docs](https://jax.readthedocs.io/en/latest/installation.html).
Expand All @@ -43,14 +43,16 @@ pip install torchdiffeq
or,

```bash
pip install jax
pip install diffrax
```

To install JAX with GPU support, use `jax[cuda12]`.

***Note: JAX-GPU support for Windows and MacOS is still limited but it runs well in WSL2.***

Finally, to install the latest version of `quantrl` locally, download the repository as `.zip` and extract the contents, or clone the repository.
Now, execute the following from *outside* the top-level directory, `ROOT_DIR`, inside which `setup.py` is located as:
Finally, to install the latest version of `quantrl`, execute:

```bash
pip install -e ROOT_DIR
```
pip install git+https://github.com/sampreet/quantrl.git
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ keywords = [
"python3",
]
readme = "README.md"
license = {file = "LICENSE.txt"}
license = {file = "LICENSE"}
requires-python = ">=3.10"
dependencies = [
"numpy<2.0.0",
Expand Down

0 comments on commit 66957b5

Please sign in to comment.