Skip to content

Commit

Permalink
Merge pull request #45 from AnthonyAndroulakis/main
Browse files Browse the repository at this point in the history
Modified readme
  • Loading branch information
kolibril13 authored Mar 6, 2024
2 parents 262d967 + 042c9b2 commit 41b5bbd
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
![demo](docs/example.png)
<img src="docs/example.png" width="60%">

# ipyNiiVue

ipyNiiVue is a Python / [Niivue](https://github.com/niivue/niivue) bridge for [Jupyter Widgets](https://jupyter.org/widgets). A Python API is used to interact with NiiVue.

## Try it online
You can try ipyniivue online at [![](https://img.shields.io/static/v1?message=Open%20in%20Colab&logo=googlecolab&labelColor=5c5c5c&color=0f80c1&label=%20&style=plastic)](https://colab.research.google.com/github/niivue/ipyniivue), [![JupyterLite](https://jupyterlite.rtfd.io/en/latest/_static/badge-launch.svg)](https://anthonyandroulakis.github.io/ipyNiiVueLite/lab?path=introduction.ipynb), or [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/niivue/ipyniivue/main?urlpath=lab/tree/examples/introduction.ipynb).
## Showcase
Try ipyniivue online!
- [![](https://img.shields.io/static/v1?message=Open%20in%20Colab&logo=googlecolab&labelColor=5c5c5c&color=0f80c1&label=%20&style=plastic)](https://colab.research.google.com/github/niivue/ipyniivue)
- [![JupyterLite](https://jupyterlite.rtfd.io/en/latest/_static/badge-launch.svg)](https://anthonyandroulakis.github.io/ipyNiiVueLite/lab?path=introduction.ipynb)
- [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/niivue/ipyniivue/main?urlpath=lab/tree/examples/introduction.ipynb)


## Getting started
Expand All @@ -15,6 +18,8 @@ You can try ipyniivue online at [![](https://img.shields.io/static/v1?message=Op
pip install ipyniivue
```

### [API Reference and Examples](https://niivue.github.io/ipyniivue)

### Development
```sh
conda create -n ipyniivue-dev -c conda-forge nodejs yarn python jupyterlab=3.6.3
Expand All @@ -33,6 +38,3 @@ jupyter lab
```

To view changes made in the typescript, reload the jupyter page. To view changes made in the python, restart the kernel.

### Usage
[documentation](docs)

0 comments on commit 41b5bbd

Please sign in to comment.