Skip to content

Commit

Permalink
Update pydeck README.md (#3702)
Browse files Browse the repository at this point in the history
  • Loading branch information
ajduberstein committed Sep 26, 2019
1 parent 7ea06ec commit e6834f6
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions bindings/python/pydeck/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/uber/deck.gl/binder?filepath=examples)

# pydeck: Beautiful maps with Python
# pydeck: Large-scale interactive data visualization in Python

![demo](https://user-images.githubusercontent.com/2204757/58838976-1538f400-8615-11e9-84f6-a2fe42bb300b.gif)

Expand Down Expand Up @@ -62,22 +62,21 @@ view_state = pdk.ViewState(

# Render
r = pdk.Deck(layers=[layer], initial_view_state=view_state)
r.show()
```

If you're outside of a Jupyter notebook, you can alternately run:
```python
r.to_html()
r.to_html('demo.html')
```

For more, check out the docs and Binder examples above.

### Debugging note

Because pydeck uses Python renders Javascript, some errors will appear only in the Javascript console.
If you encounter an error, open the Javascript console in your browser. This will be updated in future versions of pydeck.
If you encounter an issue, file it under the [deck.gl issues page](https://github.com/uber/deck.gl/issues/new?assignees=&labels=question&template=question.md&title=)
and include console output.
Currently, some errors in pydeck will only appear in your browser's developer console.
If a visualization fails to render, open the developer console.
Error handling will be expanded in future handling of pydeck.

### Issues

If you encounter an issue, file it in the [deck.gl issues page](https://github.com/uber/deck.gl/issues/new?assignees=&labels=question&template=question.md&title=)
and include your console output, if any.


### Installation from source
Expand All @@ -98,15 +97,15 @@ python3 setup.py install

## Development

```
```bash
git clone https://github.com/uber/deck.gl/
cd deck.gl
# Build the entire deck.gl project
yarn bootstrap

# Optional but recommended: Run a hot reloading development server
cd modules/jupyter-widget
export PYDECK_DEV_SERVER=http://localhost:8080 && yarn watch
yarn watch
```

To specifiy a non-default URL for the webpack dev server, you can set a URL in the `PYDECK_DEV_SERVER` environment variable,
Expand Down

0 comments on commit e6834f6

Please sign in to comment.