Metadata-Version: 1.1
Name: scibeam
Version: 0.1.0
Summary: A scientific time series analyzing tool on beam measurement
Home-page: https://github.com/SuperYuLu/SciBeam
Author: Yu Lu
Author-email: yulu@utexas.edu
License: LICENSE.txt
Description: |logo|
        
        SciBeam |Build Status| |codecov|
        ================================
        
        **SciBeam** is an open source library for analyzing time series beam
        measurement data. Using pandas dataframe and series as its base
        classing, additional time series related features are added for quick
        analysis, such as file name matching, gaussian fitting, peak analysis,
        noise filtering, plotting, etc. The flexible method chain enables fast
        data analysis on any time series data.
        
        SciBeam is originally designed for experimental physics data analysis.
        The library has been tested on the daily lab data analysis and is under
        active development in terms of bredth and deepth of scientific
        computation.
        
        Installation
        ============
        
        Dependencies
        ------------
        
        SciBeam requires:
        
        -  Python( >= 3.4)
        -  Numpy( >= 1.8.2)
        -  Scipy( >= 0.13.3)
        -  pandas ( >= 0.23.0)
        -  matplotlib ( >= 1.5.1)
        -  re
        -  os
        
        User installation
        -----------------
        
        Currently only avaliable through downloading from Github, will be
        avaliable for installation through pip soon:
        
        Download the souce code:
        
        .. code:: bash
        
           git clone https://github.com/SuperYuLu/SciBeam`  
        
        Change to the package directory:
        
        .. code:: bash
        
           cd scibeam  
        
        Install the package:
        
        ::
        
           python setup.py install  
        
        Development
        ===========
        
        Currently working on writting up testing while adding more features, the
        library is being tested in the lab on real-time data analysis when
        experiment is on.
        
        Testing
        -------
        
        The testing part is based on unittest and can be run through setuptools:
        
        .. code:: python
        
           python setup.py test  
        
        or
        
        .. code:: bash
        
           make test
        
        Status
        ------
        
        Under testing on Test PIPY.
        
        .. |logo| image:: https://raw.githubusercontent.com/SuperYuLu/SciBeam/master/img/logo.png
           :target: https://github.com/SuperYuLu/SciBeam
           :width: 500pt
        .. |Build Status| image:: https://travis-ci.org/SuperYuLu/SciBeam.svg?branch=master
           :target: https://travis-ci.org/SuperYuLu/SciBeam
        .. |codecov| image:: https://codecov.io/gh/SuperYuLu/SciBeam/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/SuperYuLu/SciBeam
        
Keywords: physics time-series data-analysis pandas
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: MIT License
