Metadata-Version: 2.1
Name: sgm-data
Version: 0.2.3b0
Summary: Module for loading, interpolating and plotting data taken at the SGM Beamline at the Canadian Light Source.
Home-page: https://github.lightsource.ca/arthurz/sgmdata
Author: Zachary Arthur
Author-email: zachary.arthur@lightsource.ca
License: MIT
Description: # Helper module for working with data from the [SGM Beamline](https://sgm.lightsource.ca) 
        ### Installation:
        Using pip:
        ```commandline
        pip install sgm-data
        ```
        or from source: 
        ```commandline
        git clone https://github.lightsource.ca/arthurz/sgmdata ./sgmdata
        cd sgmdata
        python setup.py install
        ```
        ### Usage:
        First import the package, and select data to load in.
        ```python
        import sgmdata 
        data = sgmdata.SGMData(["file1.hdf5", "file2.hdf5", "..."])
        ```
        This will identify the independent axis, signals and other data within the files listed. 
        The file load list also works with [hsds](https://github.com/HDFGroup/hsds) domains.
        ```python
        data = sgmdata.SGMData(["file1.data.sgm-hdf5.lightsource.ca", "..."])
        ```
        Useful functions:
        ```python
        data.scans  #contains a dictionary of the identified data arrays loaded from your file list
        data.interpolate(start=270, stop=2000, resolution=0.5) #bin the data in scans dictionary and interpolates missing points
        data.mean() #average data with the same sample name, and spec command together. 
        ```
        Working with individual scans:
        ```python
        df = data.scans['FilePrefix'].entry1.interpolate(start=270, stop=2000, resolution=0.1) #bin data for a single scan.
        df2 = data.scans['FilePrefix'].entry1.fit_mcas() #perform batch gaussian fitting of interpolated SDD signal
        ```
        Plotting (with [Bokeh](https://docs.bokeh.org/en/latest/index.html)):
        ```python
        data.scans['FilePrefix'].entry1.plot()
        data.average.plot()
        ```
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
