Skip to content

Commit

Permalink
update readme: for installation process
Browse files Browse the repository at this point in the history
  • Loading branch information
aditya0by0 committed Aug 3, 2024
1 parent 73b9989 commit 8933066
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,24 @@ Please check the [readme](stream_viz/README.md) of our package to understand the

## Installation

To install the package, use pip:

```sh
pip install stream_viz
```
To get started with stream-viz, follow these installation instructions:

1. **Create a new Conda environment** with Python version between 3.8.0 and 3.10.0:
```sh
conda create --name your_env_name python=3.9
```
Alternatively, ensure your machine has a compatible Python version within this range.

2. **Clone the repository**:
```sh
git clone https://github.com/aditya0by0/stream-viz.git
```

3. **Navigate to the package directory and install the package**:
```sh
cd stream-viz
pip install .
```

## Example

Expand Down

0 comments on commit 8933066

Please sign in to comment.