| Name | widget-bzvisualizer JSON |
| Version |
0.2.7
JSON |
| download |
| home_page | None |
| Summary | A Jupyter widget to show the Brillouin zone of periodic crystals. |
| upload_time | 2024-05-21 14:23:23 |
| maintainer | None |
| docs_url | None |
| author | The OSSCAR team |
| requires_python | >=3.9 |
| license | BSD 3-Clause License Copyright (c) 2024, OSSCAR (Open Software Services for Classrooms and Research) team, EPFL, Lausanne, Switzerland Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
anywidget
brillouin-zone
jupyter
jupyterlab
osscar
reciprocal-space
widget
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jupyter widget: Brillouin zone visualizer
[](https://pypi.org/project/widget-bzvisualizer/)
A Jupyter widget to plot the 1st Brillouin zone of crystals. It is based on the corresponding Javascript library: https://github.com/materialscloud-org/brillouinzone-visualizer
The primary input is a crystal structure, which is parsed by [seekpath](https://github.com/giovannipizzi/seekpath) and the result is displayed by the Javascript widget using [anywidget](https://anywidget.dev/).
This repo is bootstrapped with `npm create anywidget@latest`.
## Installation & usage
```sh
pip install widget-bzvisualizer
```
For usage examples, see `example/example.ipynb`.
## Development
Install the python code:
```sh
pip install -e .[dev]
```
You then need to install the JavaScript dependencies and run the development server.
```sh
npm install
npm run dev
```
Open `example/example.ipynb` in JupyterLab, VS Code, or your favorite editor to start developing. Changes made in `js/` will be reflected in the notebook.
### Releasing and publishing a new version
In order to make a new release of the library and publish to PYPI, run
```bash
bumpver update --major/--minor/--patch
```
This will
- update version numbers, make a corresponding `git commit` and a `git tag`;
- push this commit and tag to Github, which triggers the Github Action that makes a new Github Release and publishes the package to PYPI.
## Acknowledgements
We acknowledge support from the EPFL Open Science Fund via the [OSSCAR project](http://www.osscar.org/).
Raw data
{
"_id": null,
"home_page": null,
"name": "widget-bzvisualizer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "anywidget, brillouin-zone, jupyter, jupyterlab, osscar, reciprocal-space, widget",
"author": "The OSSCAR team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2e/99/117df1fdc084e9491a7541cb1bef3010279cf78744c3bfadd0f43d0e0a27/widget_bzvisualizer-0.2.7.tar.gz",
"platform": null,
"description": "# Jupyter widget: Brillouin zone visualizer\n\n[](https://pypi.org/project/widget-bzvisualizer/)\n\nA Jupyter widget to plot the 1st Brillouin zone of crystals. It is based on the corresponding Javascript library: https://github.com/materialscloud-org/brillouinzone-visualizer\n\nThe primary input is a crystal structure, which is parsed by [seekpath](https://github.com/giovannipizzi/seekpath) and the result is displayed by the Javascript widget using [anywidget](https://anywidget.dev/).\n\nThis repo is bootstrapped with `npm create anywidget@latest`.\n\n## Installation & usage\n\n```sh\npip install widget-bzvisualizer\n```\n\nFor usage examples, see `example/example.ipynb`.\n\n## Development\n\nInstall the python code:\n\n```sh\npip install -e .[dev]\n```\n\nYou then need to install the JavaScript dependencies and run the development server.\n\n```sh\nnpm install\nnpm run dev\n```\n\nOpen `example/example.ipynb` in JupyterLab, VS Code, or your favorite editor to start developing. Changes made in `js/` will be reflected in the notebook.\n\n### Releasing and publishing a new version\n\nIn order to make a new release of the library and publish to PYPI, run\n\n```bash\nbumpver update --major/--minor/--patch\n```\n\nThis will\n\n- update version numbers, make a corresponding `git commit` and a `git tag`;\n- push this commit and tag to Github, which triggers the Github Action that makes a new Github Release and publishes the package to PYPI.\n\n## Acknowledgements\n\nWe acknowledge support from the EPFL Open Science Fund via the [OSSCAR project](http://www.osscar.org/).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, OSSCAR (Open Software Services for Classrooms and Research) team, EPFL, Lausanne, Switzerland Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A Jupyter widget to show the Brillouin zone of periodic crystals.",
"version": "0.2.7",
"project_urls": {
"Home": "https://www.osscar.org/",
"Source": "https://github.com/osscar-org/widget-bzvisualizer"
},
"split_keywords": [
"anywidget",
" brillouin-zone",
" jupyter",
" jupyterlab",
" osscar",
" reciprocal-space",
" widget"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4be743ccb969592be4b1ccf3bf82f53f5f407ea71ba3aaa29c1a0b8fd3807dc1",
"md5": "c41a9ad35fc9df2883479b89e6783550",
"sha256": "d02df61cf8754c704708fa445a3bf221330121ec9934feb9e1c1298bb948710a"
},
"downloads": -1,
"filename": "widget_bzvisualizer-0.2.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c41a9ad35fc9df2883479b89e6783550",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 129599,
"upload_time": "2024-05-21T14:23:21",
"upload_time_iso_8601": "2024-05-21T14:23:21.832523Z",
"url": "https://files.pythonhosted.org/packages/4b/e7/43ccb969592be4b1ccf3bf82f53f5f407ea71ba3aaa29c1a0b8fd3807dc1/widget_bzvisualizer-0.2.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e99117df1fdc084e9491a7541cb1bef3010279cf78744c3bfadd0f43d0e0a27",
"md5": "52ede5b3a86be07de7cc836b9dcb1280",
"sha256": "9e4cb08ef75c7af8157a21135872dfa7031b0406077de889af830fb24a14d646"
},
"downloads": -1,
"filename": "widget_bzvisualizer-0.2.7.tar.gz",
"has_sig": false,
"md5_digest": "52ede5b3a86be07de7cc836b9dcb1280",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 127797,
"upload_time": "2024-05-21T14:23:23",
"upload_time_iso_8601": "2024-05-21T14:23:23.271465Z",
"url": "https://files.pythonhosted.org/packages/2e/99/117df1fdc084e9491a7541cb1bef3010279cf78744c3bfadd0f43d0e0a27/widget_bzvisualizer-0.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-21 14:23:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osscar-org",
"github_project": "widget-bzvisualizer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "widget-bzvisualizer"
}
