Skip to content

Commit

Permalink
improve docs (#109)
Browse files Browse the repository at this point in the history
  • Loading branch information
j6k4m8 authored Oct 1, 2020
1 parent abf2bc3 commit a3d0045
Showing 1 changed file with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,28 @@ Pytri is a data visualization library for 3D rendering in a Jupyter notebook.

Under the hood, pytri uses [substrate](https://github.com/aplbrain/substrate), a fast, layer-based visualization framework built upon threejs. And importantly, **pytri visualizations persist when you export a jupyter notebook to HTML!**


## Usage

```python
from pytri import pytri

p = pytri()

p.axes()
p.scatter([[1, 2, 3], [4, 5, 6]])
```

Then, calling the following will render the result. You can call `pytri#show()` in a new jupyter cell, or in an existing one:

```python
p.show()
```

## Installation and Configuration

You do not need to install any JavaScript/node packages. You _will_ need a relatively recent browser!

### New Hotness:

```shell
Expand All @@ -42,15 +62,3 @@ git clone https://github.com/aplbrain/pytri.git
pip3 install -r requirements.txt
pip3 install -U .
```

## Usage

```python
from pytri import pytri

p = pytri()

p.axes()
p.scatter([[1, 2, 3], [4, 5, 6]])
p.show()
```

0 comments on commit a3d0045

Please sign in to comment.