| Name | signac-dashboard JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | |
| Summary | Visualize data spaces in a web browser. |
| upload_time | 2023-08-31 14:50:20 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | BSD 3-Clause License for the software signac-dashboard. Copyright (c) 2019, The Regents of the University of Michigan All rights reserved. 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 |
visualization
dashboard
signac
framework
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# <img src="https://raw.githubusercontent.com/glotzerlab/signac-dashboard/main/doc/images/palette-header.png" width="75" height="58"> signac-dashboard - data visualization for signac
[](https://numfocus.org/sponsored-projects/affiliated-projects)
[](https://pypi.org/project/signac-dashboard/)
[](https://anaconda.org/conda-forge/signac-dashboard)
[](https://docs.signac.io)
[](https://github.com/glotzerlab/signac-dashboard/blob/main/LICENSE.txt)
[](https://pypistats.org/packages/signac-dashboard)
[](https://signac.io/slack-invite/)
[](https://twitter.com/signacdata)
[](https://github.com/glotzerlab/signac-dashboard/)
The [**signac** framework](https://signac.io) helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility.
The **signac-dashboard** package allows users to rapidly visualize and analyze data from a **signac** project in a web browser.
## Resources
- [Dashboard topic guide](https://docs.signac.io/en/latest/dashboard.html):
Introduction to **signac-dashboard**.
- [Dashboard documentation](https://docs.signac.io/projects/dashboard/):
Package reference and APIs.
- [Dashboard examples](examples/):
Example dashboards demonstrating a variety of use cases.
- [Framework documentation](https://docs.signac.io/):
Examples, tutorials, topic guides, and package Python APIs.
- [Slack Chat Support](https://signac.io/slack-invite/):
Get help and ask questions on the **signac** Slack workspace.
- [**signac** website](https://signac.io/):
Framework overview and news.
## Installation
The recommended installation method for **signac-dashboard** is through **conda** or **pip**.
The software is tested for Python 3.8+ and is built for all major platforms.
To install **signac-dashboard** *via* the [conda-forge](https://conda-forge.github.io/) channel, execute:
```bash
conda install -c conda-forge signac-dashboard
```
To install **signac-dashboard** *via* **pip**, execute:
```bash
pip install signac-dashboard
```
**Detailed information about alternative installation methods can be found in the [documentation](https://docs.signac.io/projects/dashboard/en/latest/installation.html).**
## Quickstart
In an existing **signac** project directory, create a file `dashboard.py`:
```python
from signac_dashboard import Dashboard
from signac_dashboard.modules import StatepointList, DocumentList, ImageViewer, Schema
if __name__ == '__main__':
modules = [StatepointList(), DocumentList(), ImageViewer(context="JobContext"),
ImageViewer(context="ProjectContext"), Schema()]
Dashboard(modules=modules).main()
```
Then launch the dashboard:
```bash
$ python dashboard.py run
```
Raw data
{
"_id": null,
"home_page": "",
"name": "signac-dashboard",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "signac Developers <signac-support@umich.edu>",
"keywords": "visualization,dashboard,signac,framework",
"author": "",
"author_email": "\"Bradley Dice et al.\" <bdice@bradleydice.com>",
"download_url": "https://files.pythonhosted.org/packages/21/07/972d34604ec9f379495a8757ebefcd9c150fe6e203fc806b32b2dbd31a73/signac-dashboard-0.6.0.tar.gz",
"platform": null,
"description": "# <img src=\"https://raw.githubusercontent.com/glotzerlab/signac-dashboard/main/doc/images/palette-header.png\" width=\"75\" height=\"58\"> signac-dashboard - data visualization for signac\n\n[](https://numfocus.org/sponsored-projects/affiliated-projects)\n[](https://pypi.org/project/signac-dashboard/)\n[](https://anaconda.org/conda-forge/signac-dashboard)\n[](https://docs.signac.io)\n[](https://github.com/glotzerlab/signac-dashboard/blob/main/LICENSE.txt)\n[](https://pypistats.org/packages/signac-dashboard)\n[](https://signac.io/slack-invite/)\n[](https://twitter.com/signacdata)\n[](https://github.com/glotzerlab/signac-dashboard/)\n\nThe [**signac** framework](https://signac.io) helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility.\n\nThe **signac-dashboard** package allows users to rapidly visualize and analyze data from a **signac** project in a web browser.\n\n## Resources\n\n- [Dashboard topic guide](https://docs.signac.io/en/latest/dashboard.html):\n Introduction to **signac-dashboard**.\n- [Dashboard documentation](https://docs.signac.io/projects/dashboard/):\n Package reference and APIs.\n- [Dashboard examples](examples/):\n Example dashboards demonstrating a variety of use cases.\n- [Framework documentation](https://docs.signac.io/):\n Examples, tutorials, topic guides, and package Python APIs.\n- [Slack Chat Support](https://signac.io/slack-invite/):\n Get help and ask questions on the **signac** Slack workspace.\n- [**signac** website](https://signac.io/):\n Framework overview and news.\n\n## Installation\n\nThe recommended installation method for **signac-dashboard** is through **conda** or **pip**.\nThe software is tested for Python 3.8+ and is built for all major platforms.\n\nTo install **signac-dashboard** *via* the [conda-forge](https://conda-forge.github.io/) channel, execute:\n\n```bash\nconda install -c conda-forge signac-dashboard\n```\n\nTo install **signac-dashboard** *via* **pip**, execute:\n\n```bash\npip install signac-dashboard\n```\n\n**Detailed information about alternative installation methods can be found in the [documentation](https://docs.signac.io/projects/dashboard/en/latest/installation.html).**\n\n\n## Quickstart\n\nIn an existing **signac** project directory, create a file `dashboard.py`:\n\n```python\nfrom signac_dashboard import Dashboard\nfrom signac_dashboard.modules import StatepointList, DocumentList, ImageViewer, Schema\n\nif __name__ == '__main__':\n modules = [StatepointList(), DocumentList(), ImageViewer(context=\"JobContext\"),\n ImageViewer(context=\"ProjectContext\"), Schema()]\n Dashboard(modules=modules).main()\n```\n\nThen launch the dashboard:\n\n```bash\n$ python dashboard.py run\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License for the software signac-dashboard. Copyright (c) 2019, The Regents of the University of Michigan All rights reserved. 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": "Visualize data spaces in a web browser.",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://docs.signac.io",
"Download": "https://pypi.org/project/signac-dashboard/",
"Homepage": "https://signac.io",
"Issues": "https://github.com/glotzerlab/signac-dashboard/issues",
"Source": "https://github.com/glotzerlab/signac-dashboard"
},
"split_keywords": [
"visualization",
"dashboard",
"signac",
"framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9d341d1fbbdf1f21c092d1ea69e0aa0d41f0097eb50dd696d57b46273c05ea8",
"md5": "b238f17a2a4340f40f91e8f052b10be9",
"sha256": "73b0b766571699ce9188e8bc2c3ff62b1eff12c528ab4900b3e833105752fdeb"
},
"downloads": -1,
"filename": "signac_dashboard-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b238f17a2a4340f40f91e8f052b10be9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1238415,
"upload_time": "2023-08-31T14:50:17",
"upload_time_iso_8601": "2023-08-31T14:50:17.897653Z",
"url": "https://files.pythonhosted.org/packages/b9/d3/41d1fbbdf1f21c092d1ea69e0aa0d41f0097eb50dd696d57b46273c05ea8/signac_dashboard-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2107972d34604ec9f379495a8757ebefcd9c150fe6e203fc806b32b2dbd31a73",
"md5": "80d4e67f4414591dc9155b8b43ee41b1",
"sha256": "2b375befdf7106caaaf6b61dbf1141950bf166e5a5649f70f3915ffbdc1ebd58"
},
"downloads": -1,
"filename": "signac-dashboard-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "80d4e67f4414591dc9155b8b43ee41b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1201644,
"upload_time": "2023-08-31T14:50:20",
"upload_time_iso_8601": "2023-08-31T14:50:20.088412Z",
"url": "https://files.pythonhosted.org/packages/21/07/972d34604ec9f379495a8757ebefcd9c150fe6e203fc806b32b2dbd31a73/signac-dashboard-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-31 14:50:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glotzerlab",
"github_project": "signac-dashboard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "signac-dashboard"
}
