-
Notifications
You must be signed in to change notification settings - Fork 155
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.
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 #1340
Merged
janfb
merged 1 commit into
sbi-dev:main
from
matthewfeickert:docs/add-conda-forge-install-docs
Dec 21, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,35 @@ | ||
# Installation | ||
|
||
`sbi` requires Python 3.8 or higher. A GPU is not required, but can lead to | ||
`sbi` requires Python 3.9 or higher. A GPU is not required, but can lead to | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Modern There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. good catch, thanks! |
||
speed-up in some cases. We recommend using a | ||
[`conda`](https://docs.conda.io/en/latest/miniconda.html) virtual environment | ||
([Miniconda installation | ||
instructions](https://docs.conda.io/en/latest/miniconda.html)). If `conda` is | ||
installed on the system, an environment for installing `sbi` can be created as | ||
follows: | ||
|
||
```commandline | ||
```console | ||
# Create an environment for sbi (indicate Python 3.8 or higher); activate it | ||
$ conda create -n sbi_env python=3.10 && conda activate sbi_env | ||
$ conda create -n sbi_env python=3.12 && conda activate sbi_env | ||
``` | ||
|
||
Independent of whether you are using `conda` or not, `sbi` can be installed | ||
using `pip`: | ||
|
||
```commandline | ||
pip install sbi | ||
``` | ||
python -m pip install sbi | ||
``` | ||
|
||
To install and add `sbi` to a project with [`pixi`](https://pixi.sh/), from the project directory run | ||
|
||
``` | ||
pixi add sbi | ||
``` | ||
|
||
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 sbi | ||
``` | ||
|
||
To test the installation, drop into a Python prompt and run | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section required restructuring as otherwise you're interviewing too many different (and not needed) ideas of different environment management tools.
Revision requests welcome of course.