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.

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: Update README #243

Merged
merged 1 commit into from
May 30, 2024
Merged
Changes from all commits
Commits
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
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,37 +108,38 @@ For **Directed Acyclic Graph (DAG)** implementation, there are 4 main components

## Installation

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

### a) Installation with pip

#### Basic Installation

To install `bigtree`, run the following line in command prompt:

```console
$ pip install bigtree
```

If tree needs to use pandas or polars methods, it requires additional dependencies.
Run the following lines in command prompt:
#### Installing optional dependencies

`bigtree` have a number of optional dependencies, which can be installed using "extras" syntax.

```console
$ pip install 'bigtree[pandas]'
$ pip install 'bigtree[polars]'
$ pip install 'bigtree[extra_1, extra_2]'
```

If tree needs to be exported to image, it requires additional dependencies.
Run the following lines in command prompt:
Examples of extra packages include:

```console
$ pip install 'bigtree[image]'
$ brew install gprof2dot # for MacOS
$ conda install graphviz # for Windows
```
- `all`: include all optional dependencies
- `image`: for exporting tree to image
- `pandas`: for pandas methods
- `polars`: for polars methods

Alternatively, install all optional dependencies with the following line in command prompt:
For `image` extra dependency, you may need to install more plugins.

```console
$ pip install 'bigtree[all]'
$ brew install gprof2dot # for MacOS
$ conda install graphviz # for Windows
```

### b) Installation with conda
Expand Down
Loading