Skip to content

Commit

Permalink
Added demo, changed readme accordingly
Browse files Browse the repository at this point in the history
  • Loading branch information
sebasguts committed Mar 20, 2017
1 parent 376d010 commit f33f40c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ build/*
wrapper-kernel/build/*
*__pychache__
jupyter_kernel_polymake/__pycache__/
dist/
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# jupyter-polymake
###Jupyter kernels for polymake
# jupyter kernel polymake
###Jupyter kernel for polymake

This is the current beta version of a jupyter kernel for polymake. It uses the `ipykernel` and
`pexpect` python module, along with some sugar.
Expand All @@ -12,7 +12,7 @@ and [Jupyter](http://jupyter.org). For most Linux and OS X versions, all the pac
accessible via `pip`. For the usage of interactive widgets you also need the `ipywidgets` python module
installed.

Also, a recent version of [polymake](http://polymake.org) is required.
Also, the latest version of [polymake](http://polymake.org) is required.

## polymake-kernel

Expand All @@ -22,7 +22,6 @@ be executed as the user who wants to use jupyter, e.g., your normal user.

```shell
python setup.py install
python -m jupyter_polymake_wrapper.install
```

If one of those commands fail, please make sure you have the proper rights. Also, check whether your
Expand All @@ -41,5 +40,4 @@ Note that this kernel assumes that `polymake` is in the `PATH`.

## Examples

Please have a look at the Demo worksheet. If you want to have a look at an interactive widget,
please have a look at SliderWidgetWithJohnsonSolids.
Please have a look at the Demo worksheet.

0 comments on commit f33f40c

Please sign in to comment.