gemviz


Namegemviz JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryVisualize Bluesky data from tiled server.
upload_time2024-03-30 12:57:21
maintainerNone
docs_urlNone
authorOllivier Gassant
requires_python<3.12,>=3.8
licenseCopyright (c) 2023-2024, UChicago Argonne, LLC All Rights Reserved gemviz BCDA, Advanced Photon Source, Argonne National Laboratory OPEN SOURCE LICENSE 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. Software changes, modifications, or derivative works, should be noted with comments and the author and organization's name. 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 names of UChicago Argonne, LLC or the Department of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 4. The software and the end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software produced by UChicago Argonne, LLC under Contract No. DE-AC02-06CH11357 with the Department of Energy." **************************************************************************** DISCLAIMER THE SOFTWARE IS SUPPLIED "AS IS" WITHOUT WARRANTY OF ANY KIND. Neither the United States GOVERNMENT, nor the United States Department of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, data, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights. ****************************************************************************
keywords bluesky databroker tiled catalog
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # gemviz

Python Qt5 application to visualize Bluesky data from tiled server.

GH tag | GH release | PyPI | conda-forge
--- | --- | --- | ---
[![tag](https://img.shields.io/github/tag/BCDA-APS/gemviz.svg)](https://github.com/BCDA-APS/gemviz/tags) | [![release](https://img.shields.io/github/release/BCDA-APS/gemviz.svg)](https://github.com/BCDA-APS/gemviz/releases) | [![PyPi](https://img.shields.io/pypi/v/gemviz.svg)](https://pypi.python.org/pypi/gemviz) | [![conda-forge](https://img.shields.io/conda/vn/conda-forge/gemviz)](https://anaconda.org/conda-forge/gemviz)

Python version(s) | Unit Tests | Code Coverage | License
--- | --- | --- | ---
[![Python version](https://img.shields.io/pypi/pyversions/gemviz.svg)](https://pypi.python.org/pypi/gemviz) | [![Unit Tests](https://github.com/BCDA-APS/gemviz/workflows/Unit%20Tests%20%26%20Code%20Coverage/badge.svg)](https://github.com/BCDA-APS/gemviz/actions/workflows/unit_tests.yml) | [![Coverage Status](https://coveralls.io/repos/github/BCDA-APS/gemviz/badge.svg?branch=main)](https://coveralls.io/github/BCDA-APS/gemviz?branch=main) | [![license: ANL](https://img.shields.io/badge/license-ANL-brightgreen)](/LICENSE.txt)

## Goals

- minimum: PyQt app that can select runs, show line charts
- ideal: add database filters, config file, autodetect data types, and representations
- stretch: data visualization integrate with https://github.com/BCDA-APS/qs-web2023

## Web Links

- https://github.com/bluesky/tiled
- https://github.com/bluesky/bluesky-widgets
- [Tiled Python Client Demonstration](https://github.com/BCDA-APS/bdp-tiled/blob/main/demo_client.ipynb) - shows the JSON API between tiled server and client
- [Tiled Python Client Python API](https://github.com/BCDA-APS/bdp-tiled/blob/main/pyapi_client.py) - terse example using `tiled.client` libary

## How to run this code?

First said, this software application is pre-release and may contain significant unhandled
bugs.  Please [report any you encounter](https://github.com/BCDA-APS/gemviz/issues/new) or
feature requests, too.

Suggested installation for developers is to use
`pip` with its *editable* mode:

This project is still in development.
We have [plans for production
release](https://github.com/orgs/BCDA-APS/projects/6).
Until the production release, you should run `gemviz`
as would a developer by following these instructions:

1. Navigate to a directory where you have similar software projects
2. `git clone https://github.com/BCDA-APS/gemviz`
   - only need to do this once, assumes you have `git` command
3. `cd gemviz`
4. `conda env create --force -n gemviz -f ./env.yml`
   - only need to do this once, assumes you have `conda` command
5. `conda activate gemviz`
6. `pip install -e .`
7. `gemviz &`

The [gemviz package is now available on PyPI](https://pypi.org/project/gemviz/) which means
a development version can be installed via `pip`:

```bash
pip install gemviz
```

## Acknowledgements

We'd like to thank the [GEM fellow program](https://www.gemfellowship.org/) for sponsoring
an intern fellowship for the development of this software at the Advanced Photon Source.

"This product includes software produced by UChicago Argonne, LLC 
under Contract No. DE-AC02-06CH11357 with the Department of Energy."

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "gemviz",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.8",
    "maintainer_email": "Fanny Rodolakis <rodolakis@anl.gov>, Pete Jemian <prjemian@gmail.com>",
    "keywords": "bluesky, databroker, tiled, catalog",
    "author": "Ollivier Gassant",
    "author_email": "Fanny Rodolakis <rodolakis@anl.gov>, Pete Jemian <prjemian@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/bb/d5/a48e745c061f655cc1a397d17ff652e25d8504dbba3895cf6e135244b007/gemviz-0.1.0.tar.gz",
    "platform": null,
    "description": "# gemviz\n\nPython Qt5 application to visualize Bluesky data from tiled server.\n\nGH tag | GH release | PyPI | conda-forge\n--- | --- | --- | ---\n[![tag](https://img.shields.io/github/tag/BCDA-APS/gemviz.svg)](https://github.com/BCDA-APS/gemviz/tags) | [![release](https://img.shields.io/github/release/BCDA-APS/gemviz.svg)](https://github.com/BCDA-APS/gemviz/releases) | [![PyPi](https://img.shields.io/pypi/v/gemviz.svg)](https://pypi.python.org/pypi/gemviz) | [![conda-forge](https://img.shields.io/conda/vn/conda-forge/gemviz)](https://anaconda.org/conda-forge/gemviz)\n\nPython version(s) | Unit Tests | Code Coverage | License\n--- | --- | --- | ---\n[![Python version](https://img.shields.io/pypi/pyversions/gemviz.svg)](https://pypi.python.org/pypi/gemviz) | [![Unit Tests](https://github.com/BCDA-APS/gemviz/workflows/Unit%20Tests%20%26%20Code%20Coverage/badge.svg)](https://github.com/BCDA-APS/gemviz/actions/workflows/unit_tests.yml) | [![Coverage Status](https://coveralls.io/repos/github/BCDA-APS/gemviz/badge.svg?branch=main)](https://coveralls.io/github/BCDA-APS/gemviz?branch=main) | [![license: ANL](https://img.shields.io/badge/license-ANL-brightgreen)](/LICENSE.txt)\n\n## Goals\n\n- minimum: PyQt app that can select runs, show line charts\n- ideal: add database filters, config file, autodetect data types, and representations\n- stretch: data visualization integrate with https://github.com/BCDA-APS/qs-web2023\n\n## Web Links\n\n- https://github.com/bluesky/tiled\n- https://github.com/bluesky/bluesky-widgets\n- [Tiled Python Client Demonstration](https://github.com/BCDA-APS/bdp-tiled/blob/main/demo_client.ipynb) - shows the JSON API between tiled server and client\n- [Tiled Python Client Python API](https://github.com/BCDA-APS/bdp-tiled/blob/main/pyapi_client.py) - terse example using `tiled.client` libary\n\n## How to run this code?\n\nFirst said, this software application is pre-release and may contain significant unhandled\nbugs.  Please [report any you encounter](https://github.com/BCDA-APS/gemviz/issues/new) or\nfeature requests, too.\n\nSuggested installation for developers is to use\n`pip` with its *editable* mode:\n\nThis project is still in development.\nWe have [plans for production\nrelease](https://github.com/orgs/BCDA-APS/projects/6).\nUntil the production release, you should run `gemviz`\nas would a developer by following these instructions:\n\n1. Navigate to a directory where you have similar software projects\n2. `git clone https://github.com/BCDA-APS/gemviz`\n   - only need to do this once, assumes you have `git` command\n3. `cd gemviz`\n4. `conda env create --force -n gemviz -f ./env.yml`\n   - only need to do this once, assumes you have `conda` command\n5. `conda activate gemviz`\n6. `pip install -e .`\n7. `gemviz &`\n\nThe [gemviz package is now available on PyPI](https://pypi.org/project/gemviz/) which means\na development version can be installed via `pip`:\n\n```bash\npip install gemviz\n```\n\n## Acknowledgements\n\nWe'd like to thank the [GEM fellow program](https://www.gemfellowship.org/) for sponsoring\nan intern fellowship for the development of this software at the Advanced Photon Source.\n\n\"This product includes software produced by UChicago Argonne, LLC \nunder Contract No. DE-AC02-06CH11357 with the Department of Energy.\"\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2023-2024, UChicago Argonne, LLC  All Rights Reserved  gemviz  BCDA, Advanced Photon Source, Argonne National Laboratory   OPEN SOURCE LICENSE  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.  Software changes, modifications, or derivative works, should be noted with comments and the author and organization's name.  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 names of UChicago Argonne, LLC or the Department of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  4. The software and the end-user documentation included with the redistribution, if any, must include the following acknowledgment:  \"This product includes software produced by UChicago Argonne, LLC under Contract No. DE-AC02-06CH11357 with the Department of Energy.\"  ****************************************************************************  DISCLAIMER  THE SOFTWARE IS SUPPLIED \"AS IS\" WITHOUT WARRANTY OF ANY KIND.  Neither the United States GOVERNMENT, nor the United States Department of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, data, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights.  **************************************************************************** ",
    "summary": "Visualize Bluesky data from tiled server.",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/BCDA-APS/gemviz/issues",
        "Homepage": "https://github.com/BCDA-APS/gemviz"
    },
    "split_keywords": [
        "bluesky",
        " databroker",
        " tiled",
        " catalog"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5d8af7d5598d28c504d2cab62152a9fde9dfdb0e816a9b580749ba6239becb4a",
                "md5": "e38f576c1149de6f35597f034c74af14",
                "sha256": "344c328af60b6ad8cc7da63a0ded91676662da41801776aaf9db0131f9fa400e"
            },
            "downloads": -1,
            "filename": "gemviz-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e38f576c1149de6f35597f034c74af14",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.8",
            "size": 119607,
            "upload_time": "2024-03-30T12:57:19",
            "upload_time_iso_8601": "2024-03-30T12:57:19.499441Z",
            "url": "https://files.pythonhosted.org/packages/5d/8a/f7d5598d28c504d2cab62152a9fde9dfdb0e816a9b580749ba6239becb4a/gemviz-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bbd5a48e745c061f655cc1a397d17ff652e25d8504dbba3895cf6e135244b007",
                "md5": "b93d637705e5fa1b33705bcca1bd833f",
                "sha256": "740b4be1938320efd84ab6845aadaeb71c3047de1c927625613539e30b6e844a"
            },
            "downloads": -1,
            "filename": "gemviz-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b93d637705e5fa1b33705bcca1bd833f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.8",
            "size": 113672,
            "upload_time": "2024-03-30T12:57:21",
            "upload_time_iso_8601": "2024-03-30T12:57:21.000394Z",
            "url": "https://files.pythonhosted.org/packages/bb/d5/a48e745c061f655cc1a397d17ff652e25d8504dbba3895cf6e135244b007/gemviz-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-30 12:57:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BCDA-APS",
    "github_project": "gemviz",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gemviz"
}
        
Elapsed time: 0.23716s