Metadata-Version: 2.1
Name: tweezepy
Version: 0.1.6
Summary: Single-molecule pulling analysis package
Home-page: https://github.com/pypa/tweezepy
Author: Ian Morgan
Author-email: ilmorgan@ucsb.edu
License: LICENSE.txt
Project-URL: Source, https://github.com/ianlmorgan/tweezepy/
Description: # tweezepy
        This is [tweezepy](https://github.com/ianlmorgan/tweezepy), a package of single-molecule pulling experiment related analysis code.
        
        # How to install
        The simplest method of installing the `tweezepy` package is via the [Python Package Index](https://packaging.python.org/glossary/#term-python-package-index-pypi) (PyPI). To install from PyPI, you will need to be able to run python from the command line and make sure you have [pip](https://packaging.python.org/key_projects/#pip) available.
        
        With pip:
        
            pip install tweezepy
        An alternative method to install `tweezepy` is with setuptools.  Clone the repository onto a local machine, then navigate to the directory.
        
        Using setuptools:
            
            cd path/to/tweezepy
        
            python setup.py install
            
        # Contents
        The `tweezepy` package includes the following modules:
        * 'smmcalibration' - tool to determine force of probe trajectories by calculating and performing maximum likelihood estimation fits to power spectral density and allan variance
        * 'simulations' - tool to simulate single-molecule probe trajectories
        
        # Example use:
        Simulate data:
        ```python
        >>> import matplotlib.pyplot as plt
        >>> from tweezepy.simulations import downsampled_trace
        >>> alpha,kappa,fsample,N = 1e-5,.001,400,10240
        >>> xtrace = downsampled_trace(alpha,kappa,fsample,N)
        >>> plt.plot(xtrace)
        >>> plt.show()
        ```
        <img src="examples/example_trace.png" width=600>
        
        Power spectral density:
        ```python
        >>> from tweezepy.smmcalibration import PSD
        >>> psd = PSD(xtrace,fsample)
        >>> pars,errs,covs = psd.mlefit()
        >>> psd.plot()
        ```
        
        <img src="examples/example1.png" width="600">
        
        Allan variance:
        ```python
        >>> from tweezepy.smmcalibration import AV
        >>> av = AV(xtrace,fsample)
        >>> pars,errs,covs = av.mlefit()
        >>> av.plot()
        ```
        <img src="examples/example2.png" width="600">
        
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
