Metadata-Version: 2.1
Name: voila-osscar-template
Version: 0.3.2
Summary: OSSCAR template for voila
Home-page: https://github.com/osscar-org/osscar-voila-template
Author: Dou Du
Author-email: dou.du@epfl.ch
License: UNKNOWN
Keywords: ipython,jupyter,widgets,voila
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

# Voila Template for the OSSCAR project.   

This is a Voila template for applications developed by the OSSCAR project.

The template is called `osscar` and can be invoked either by using the
`--template=osscar` `voila` CLI option, setting it explicitly in a Notebook's
metadata or in a Jupyter config file.  See [the Voilà
documentation](https://voila.readthedocs.io/en/stable/customize.html#controlling-the-nbconvert-template)
on how to invoke templates for more information.

## Try it with Binder!

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/osscar-org/voila-osscar-template/develop?urlpath=%2Fvoila%2Frender%2Fexample-notebooks%2Fgaussian_process_regression.ipynb)


## Installation

```bash
pip install voila-osscar-template
```

## Usage

```bash
voila --template=osscar example.ipynb
```

## License

This repository and all files in it are licensed under the [BSD
license](LICENSE), copyright (c) by Voilà contributors.

# Acknowledgements

We acknowledge support from the EPFL Open Science Fund via the [OSSCAR](http://www.osscar.org) project.

<img src='http://www.osscar.org/wp-content/uploads/2019/03/OSSCAR-logo.png' width='230'>


