# Voilà template for Materials Cloud
This is the Voilà template for the Materials Cloud project.
It implements the standard Materials Cloud header and CSS.
The template is called `materialscloud` and can be invoked either by using the `--template=materialscloud` `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!
[](https://mybinder.org/v2/gh/materialscloud-org/voila-materialscloud-template/develop?urlpath=%2Fvoila%2Frender%2Fexample-notebooks%2Fexample.ipynb)
## Installation
```bash
pip install voila-materialscloud-template
```
## Usage
There are two different templates for deploying Voilà at Materials Cloud website, which are "materialscloud-tool" and "materialscloud-discover".
At [Materials Cloud](https://materialscloud.org), the [WORK](https://www.materialscloud.org/work) section have a collection of simulation tools and services. To deploy such applications, one need use the "materialscloud-tool" template as:
```bash
voila --template=materialscloud-tool example.ipynb
```
In the [DISCOVER](https://www.materialscloud.org/discover) section, it shows curated research data with tailored visualizations. One need to use the "materialscloud-discover" template
to deploy the apps.
```bash
voila --template=materialscloud-discover example.ipynb
```
## License
This repository and all files in it are licensed under the [BSD license](LICENSE), copyright (c) by Voilà contributors.
Raw data
{
"_id": null,
"home_page": "https://github.com/materialscloud-org/voila-materialscloud-template",
"name": "voila-materialscloud-template",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "voila jupyter materialscloud",
"author": "Dou Du and Casper Welzel Andersen",
"author_email": "dou.du@epfl.ch",
"download_url": "https://files.pythonhosted.org/packages/4f/4a/f1f9ac937907876cc3ab302ad5a8317c79ee1c5bfabb51d7feaa6c71727f/voila-materialscloud-template-0.3.17.tar.gz",
"platform": null,
"description": "# Voil\u00e0 template for Materials Cloud \n\nThis is the Voil\u00e0 template for the Materials Cloud project.\n\nIt implements the standard Materials Cloud header and CSS.\n\nThe template is called `materialscloud` and can be invoked either by using the `--template=materialscloud` `voila` CLI option, setting it explicitly in a Notebook's metadata or in a Jupyter config file.\nSee [the Voil\u00e0 documentation](https://voila.readthedocs.io/en/stable/customize.html#controlling-the-nbconvert-template) on how to invoke templates for more information.\n\n## Try it with Binder!\n\n[](https://mybinder.org/v2/gh/materialscloud-org/voila-materialscloud-template/develop?urlpath=%2Fvoila%2Frender%2Fexample-notebooks%2Fexample.ipynb)\n\n## Installation\n\n```bash\npip install voila-materialscloud-template\n```\n\n## Usage\n\nThere are two different templates for deploying Voil\u00e0 at Materials Cloud website, which are \"materialscloud-tool\" and \"materialscloud-discover\".\n\nAt [Materials Cloud](https://materialscloud.org), the [WORK](https://www.materialscloud.org/work) section have a collection of simulation tools and services. To deploy such applications, one need use the \"materialscloud-tool\" template as:\n\n```bash\nvoila --template=materialscloud-tool example.ipynb\n```\n\nIn the [DISCOVER](https://www.materialscloud.org/discover) section, it shows curated research data with tailored visualizations. One need to use the \"materialscloud-discover\" template\nto deploy the apps.\n\n```bash\nvoila --template=materialscloud-discover example.ipynb\n```\n\n## License\n\nThis repository and all files in it are licensed under the [BSD license](LICENSE), copyright (c) by Voil\u00e0 contributors.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Voil\u00e0 template for Materials Cloud that implements the Materials Cloud header and CSS.",
"version": "0.3.17",
"project_urls": {
"Homepage": "https://github.com/materialscloud-org/voila-materialscloud-template"
},
"split_keywords": [
"voila",
"jupyter",
"materialscloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5b9497c3685ce9bb70f26a8d1894ad5ac13ae22216a870b101cde6c2d5be9ab",
"md5": "5dbd50b273c6b4b4f62fe83217b02b12",
"sha256": "fa702fc42fa9f37af37da156276aca83c52d2b4f4c7c8365956d887940456406"
},
"downloads": -1,
"filename": "voila_materialscloud_template-0.3.17-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5dbd50b273c6b4b4f62fe83217b02b12",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 2144,
"upload_time": "2023-09-06T08:43:19",
"upload_time_iso_8601": "2023-09-06T08:43:19.820510Z",
"url": "https://files.pythonhosted.org/packages/b5/b9/497c3685ce9bb70f26a8d1894ad5ac13ae22216a870b101cde6c2d5be9ab/voila_materialscloud_template-0.3.17-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f4af1f9ac937907876cc3ab302ad5a8317c79ee1c5bfabb51d7feaa6c71727f",
"md5": "c7245e85e65bdd0b9b8c122bec1191ab",
"sha256": "5272cb6821dd5f30753774e7c90d16045a9fabed1ef54944c74797f869eb95a3"
},
"downloads": -1,
"filename": "voila-materialscloud-template-0.3.17.tar.gz",
"has_sig": false,
"md5_digest": "c7245e85e65bdd0b9b8c122bec1191ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 575138,
"upload_time": "2023-09-06T08:43:21",
"upload_time_iso_8601": "2023-09-06T08:43:21.278105Z",
"url": "https://files.pythonhosted.org/packages/4f/4a/f1f9ac937907876cc3ab302ad5a8317c79ee1c5bfabb51d7feaa6c71727f/voila-materialscloud-template-0.3.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-06 08:43:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "materialscloud-org",
"github_project": "voila-materialscloud-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "voila-materialscloud-template"
}
JSON
