Metadata-Version: 2.1
Name: gemviz
Version: 0.0.2.dev2
Summary: Visualize Bluesky data from tiled server.
Author: Ollivier Gassant
Author-email: Fanny Rodolakis <rodolakis@anl.gov>, Pete Jemian <prjemian@gmail.com>
Maintainer-email: Fanny Rodolakis <rodolakis@anl.gov>, Pete Jemian <prjemian@gmail.com>
License: Copyright (c) 2023, 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.
        
        ****************************************************************************
        
Project-URL: Homepage, https://github.com/BCDA-APS/gemviz
Project-URL: Bug Tracker, https://github.com/BCDA-APS/gemviz/issues
Keywords: bluesky,databroker,tiled,catalog
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: Freely Distributable
Classifier: License :: Public Domain
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# gemviz

Python Qt5 application to visualize Bluesky data from tiled server.

## 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 &`

## 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."
