Skip to content

Commit

Permalink
ci: fix coverage + minor touch ups (#86)
Browse files Browse the repository at this point in the history
* ci: fix coverage + minor touch ups

* install hatch

* run CI on main

* oops, fix syntax

* add conda

* 3.13 in too

* a bit more cleanup
  • Loading branch information
Saransh-cpp authored Dec 31, 2024
1 parent 5d478d0 commit 0022adf
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
16 changes: 8 additions & 8 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0022adf

Please sign in to comment.