Skip to content

Commit

Permalink
Update README and add CODECOV_TOKEN env to workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
timmens committed Sep 10, 2024
1 parent a392525 commit 89943f1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ jobs:
- name: Upload coverage report
if: runner.os == 'Linux' && matrix.python-version == '3.12'
uses: codecov/codecov-action@v4
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
# run-mypy:
# name: Run mypy on Python 3.12
# runs-on: ubuntu-latest
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ estimators were proposed. None of them is implemented in standard econometrics p

## Installation

The package can be installed via PyPI or via GitHub. To do so, type the following in a
> **Warning:** To run skillmodels you need to install jax and jaxlib. If you aim to run
> skillmodels on a GPU, you need to install jaxlib with CUDA support (for Linux) or with
> support for AMD GPUs / ARM-based Silicon GPUs (for MacOS). In any case, for
> installation of jax and jaxlib, please consult the jax
> [docs](https://jax.readthedocs.io/en/latest/installation.html#supported-platforms).
Skillmodels can be installed via PyPI or via GitHub. To do so, type the following in a
terminal:

```console
Expand Down

0 comments on commit 89943f1

Please sign in to comment.