From 66957b5b5ff4d5250144511df6f847545ef62a9a Mon Sep 17 00:00:00 2001 From: Sampreet Kalita <9553215+Sampreet@users.noreply.github.com> Date: Mon, 14 Oct 2024 23:33:41 +0530 Subject: [PATCH] Update CI and README --- .github/workflows/python-tox.yml | 4 ++-- LICENSE.txt => LICENSE | 0 README.md | 12 +++++++----- pyproject.toml | 2 +- 4 files changed, 10 insertions(+), 8 deletions(-) rename LICENSE.txt => LICENSE (100%) diff --git a/.github/workflows/python-tox.yml b/.github/workflows/python-tox.yml index fe8dca2..333cd2b 100644 --- a/.github/workflows/python-tox.yml +++ b/.github/workflows/python-tox.yml @@ -13,7 +13,7 @@ jobs: matrix: os: [ ubuntu-latest, - macos-12, + macos-latest, windows-latest, ] @@ -29,7 +29,7 @@ jobs: - name: Install package run: pip install -e . - tox: + test: runs-on: ubuntu-latest strategy: diff --git a/LICENSE.txt b/LICENSE similarity index 100% rename from LICENSE.txt rename to LICENSE diff --git a/README.md b/README.md index bdf2bd7..18e6153 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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 -``` \ No newline at end of file +pip install git+https://github.com/sampreet/quantrl.git +``` diff --git a/pyproject.toml b/pyproject.toml index 7c799c5..247c3cf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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",