Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add conda-forge install instructions #41

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add conda-forge install instructions #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![PyPI version](https://badge.fury.io/py/pyknos.svg)](https://badge.fury.io/py/pyknos)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/pyknos.svg)](https://github.com/conda-forge/pyknos-feedstock)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/sbi-dev/pyknos/blob/master/CONTRIBUTING.md)
[![GitHub license](https://img.shields.io/github/license/mackelab/pyknos)](https://github.com/mackelab/sbi/blob/master/LICENSE.txt)

Expand All @@ -25,10 +26,26 @@ created as follows:
$ conda create -n pyknos_env python=3.12 && conda activate pyknos_env
```

Independent of whether you are using `conda` or not, `pyknos` can be installed using `pip`:
### From PyPI

```commandline
pip install pyknos
To install `pyknos` from PyPI run

```
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

```commandline

is used above, but this has no syntax highlighting effect on GitHub, so just use the default

```

as using

```console

would result in a different color.

python -m pip install pyknos
```

### From conda-forge

To install and add `pyknos` to a project with [`pixi`](https://pixi.sh/), from the project directory run

```
pixi add pyknos
```

and to install into a particular conda environment with [`conda`](https://docs.conda.io/projects/conda/), in the activated environment run

```
conda install --channel conda-forge pyknos
```

## Examples
Expand Down
Loading