diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ea3c82c..6cf35a0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -3,13 +3,16 @@ name: BPX-tests on: workflow_dispatch: pull_request: + push: + branches: + - main jobs: build: strategy: fail-fast: false matrix: - python-version: ["3.9", "3.10", "3.11"] + python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] os: [ubuntu-latest, windows-latest, macos-latest] runs-on: ${{ matrix.os }} steps: @@ -21,14 +24,11 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install hatch - pip install . + pip install hatch "coverage[toml]" - name: Lint with ruff - run: | - hatch run dev:check - - name: Test with unittest - run: | - hatch run dev:cov + run: hatch run dev:check + - name: Run unit tests + run: hatch run dev:cov - name: Upload Coverage to Codecov if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.9 uses: codecov/codecov-action@v2 diff --git a/README.md b/README.md index b9cadee..20f79fc 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,17 @@ To see how to use BPX with [PyBaMM](https://www.pybamm.org/), check out the [BPX ## 🚀 Installation The BPX package can be installed using pip + ```bash pip install bpx ``` +or conda + +```bash +conda install -c conda-forge bpx +``` + BPX is available on GNU/Linux, MacOS and Windows. We strongly recommend to install PyBaMM within a python [virtual environment](https://docs.python.org/3/tutorial/venv.html), in order not to alter any distribution python files. ## 💻 Usage