Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
arose committed Jun 14, 2016
1 parent 3fa1198 commit 079ea87
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Should work with Python 2 and 3. If you experience problems, please file an [iss

![membrane](examples/images/membrane.gif)


Table of contents
=================

Expand All @@ -26,16 +27,21 @@ Table of contents
Installation
============

Available on [PyPI](https://pypi.python.org/pypi/nglview/): `pip install nglview`.


Development version
-------------------
We highly recommend to install development version::

The development version can be installed directly from github:

python -m pip install git+https://github.com/arose/nglview

If for any reasons that the `widget` is not shown, try reinstall below packages

conda install traitlets=4.2.1 ipywidgets==4.1.1 notebook=4.1.0


Example
=======

Expand Down Expand Up @@ -69,6 +75,7 @@ the file-system, [RCSB PDB](http:www.rcsb.org), [simpletraj](https://github.com/
| `show_parmed(structure)` | Shows `ParmEd` structure
| `show_mdanalysis(univ)` | Shows `MDAnalysis` Universe or AtomGroup `univ` |


API
===

Expand Down Expand Up @@ -122,6 +129,7 @@ view = nglview.NGLWidget(struc, representation=initial_repr)
view
```


### Properties

```Python
Expand All @@ -140,7 +148,7 @@ view.parameters = {
"backgroundColor": "black",
}

# note: NGLView accepts both origin camel NGL keywords (e.g. "clipNear")
# note: NGLView accepts both origin camel NGL keywords (e.g. "clipNear")
# and snake keywords (e.g "clip_near")
```

Expand Down

0 comments on commit 079ea87

Please sign in to comment.