Skip to content

Commit b5d23ed

Browse files
authored
Merge pull request #241 from kayjan/update-docs
docs: Update docs for installation instruction
2 parents 7c53945 + 205f1ec commit b5d23ed

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

docs/install.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ title: Installation
44

55
# 💻 Installation
66

7-
There are two ways to install `bigtree`, with pip (recommended) or conda.
7+
`bigtree` requires Python 3.8+. There are two ways to install `bigtree`, with pip (recommended) or conda.
88

99
## Installation with pip
1010

11+
### Basic Installation
12+
1113
To install `bigtree`, run the following line in command prompt:
1214

1315
<!-- termynal -->
@@ -17,31 +19,30 @@ $ pip install bigtree
1719
Installed
1820
```
1921

20-
If tree needs to use pandas or polars methods, it requires additional dependencies.
21-
Run the following lines in command prompt:
22+
### Installing optional dependencies
23+
24+
`bigtree` have a number of optional dependencies, which can be installed using "extras" syntax.
2225

2326
<!-- termynal -->
2427
```console
25-
$ pip install 'bigtree[pandas]'
26-
$ pip install 'bigtree[polars]'
28+
$ pip install 'bigtree[extra_1, extra_2]'
2729
```
2830

29-
If tree needs to be exported to image, it requires additional dependencies.
30-
Run the following lines in command prompt:
31+
Examples of extra packages include:
32+
33+
- `all`: include all optional dependencies
34+
- `image`: for exporting tree to image
35+
- `pandas`: for pandas methods
36+
- `polars`: for polars methods
37+
38+
For `image` extra dependency, you may need to install more plugins.
3139

3240
<!-- termynal -->
3341
```console
34-
$ pip install 'bigtree[image]'
3542
$ brew install gprof2dot # for MacOS
3643
$ conda install graphviz # for Windows
3744
```
3845

39-
Alternatively, install all optional dependencies with the following line in command prompt:
40-
41-
<!-- termynal -->
42-
```console
43-
$ pip install 'bigtree[all]'
44-
```
4546

4647
## Installation with conda
4748

0 commit comments

Comments
 (0)