Skip to content

Commit

Permalink
docs: add conda/mamba install instructions for specific backends
Browse files Browse the repository at this point in the history
  • Loading branch information
jcrist committed Jul 15, 2023
1 parent 91ec3bc commit 91a9e74
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 12 deletions.
46 changes: 35 additions & 11 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,62 @@ hide:

# Install Ibis

=== "pip"
## Using `pip`

We suggest starting with the DuckDB backend. It's performant and fully
featured.

```sh
pip install 'ibis-framework[duckdb]'
```

If you would like to use a different backend, all of the available options are
listed below.

{% for backend in sorted(ibis.backends.base._get_backend_names()) %}
{% if backend != "spark" %}
=== "{{ backend }}"

```sh
pip install 'ibis-framework[duckdb]' # (1) (2)
pip install 'ibis-framework[{{ backend }}]'
```

1. We suggest starting with the DuckDB backend. It's performant and fully featured. If you would like to use a different backend, all of the available options are listed below.
{% endif %}
{% endfor %}

Note that the `ibis-framework` package is *not* the same as the `ibis` package
in PyPI. These two libraries cannot coexist in the same Python environment, as
they are both imported with the `ibis` module name.

2. Note that the `ibis-framework` package is *not* the same as the `ibis` package in PyPI. These two libraries cannot coexist in the same Python environment, as they are both imported with the `ibis` module name.
## Using `conda` or `mamba`

{% for mgr in ["conda", "mamba"] %}
=== "{{ mgr }}"

The base `ibis-framework` package includes support for the `duckdb`
backend. This is our recommended backend for local execution.

```sh
{{ mgr }} install -c conda-forge ibis-framework
```

{% endfor %}

## Install backend dependencies
If you would like to use a different backend, all of the available options
are listed below.

{% for backend in sorted(ibis.backends.base._get_backend_names()) %}
{% if backend != "spark" %}
=== "{{ backend }}"
=== "{{ backend }}"

```sh
pip install 'ibis-framework[{{ backend }}]'
```
```sh
{{ mgr }} install -c conda-forge ibis-{{ backend }}
```

{% endif %}
{% endfor %}

{% endfor %}


---

After you've successfully installed Ibis, try going through the tutorial:
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ plugins:
show_root_toc_entry: true
show_source: false
- mkdocs-jupyter:
execute: true
execute: false
ignore:
- "*.py"
execute_ignore:
Expand Down

0 comments on commit 91a9e74

Please sign in to comment.