Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
timmens committed Sep 10, 2024
1 parent 873b348 commit a392525
Showing 1 changed file with 39 additions and 5 deletions.
44 changes: 39 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,53 @@ estimators were proposed. None of them is implemented in standard econometrics p

## Installation

The package can be installed via conda. To do so, type the following in a terminal:
The package can be installed via PyPI or via GitHub. To do so, type the following in a
terminal:

conda config --add channels conda-forge conda install skillmodels
```console
$ pip install skillmodels
```

or

```console
$ pip install git+https://github.com/OpenSourceEconomics/skillmodels.git
```

## Documentation

[The documentation is hosted at readthedocs](https://skillmodels.readthedocs.io/en/latest/)

Alternatively, you can build it locally. After cloning the repository you can cd to the
docs directory and type:
## Developing

We use [pixi](https://pixi.sh/latest/) for our local development environment. If you
want to work with or extend the skillmodels code base you can run the tests using

```console
$ git clone https://github.com/OpenSourceEconomics/skillmodels.git
$ pixi run tests
```

This will install the development environment and run the tests. You can run
[mypy](https://mypy-lang.org/) using

```console
$ pixi run mypy
```

Before committing, install the pre-commit hooks using

```console
$ pre-commit install
```
make html

#### Documentation

You can build the documentation locally. After cloning the repository you can cd to the
docs directory and type:

```console
$ make html
```

## Citation
Expand Down

0 comments on commit a392525

Please sign in to comment.