Metadata-Version: 2.1
Name: ps-signal
Version: 0.1.8
Summary: Module for parsing and analysing data from a picoscope.
Home-page: UNKNOWN
Author: Robert Nyström
Author-email: golgafrincham@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://ps-signal.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/golgor/ps-signal/
Description: # Picoscope Signal Analyzer
        Module used to import .csv files made form a pico scope and analyse the data.
        
        ## How to install
        Clone repository
        ```
        $ git clone git@github.com:golgor/ps_signal.git
        ```
        Navigate to the cloned repo
        ```
        $ cd ps_signal
        ```
        Install using pip
        ```
        $ pip install .
        ```
        ## How to use
        This is a script using a Command Line Interface (CLI). Either you can run it by:
        ```
        $ python -m ps_signal
        ```
        or
        ```
        $ ps_signal
        ```
        ### Mandatory arguments
        * file - The path to a file containing data that have been exported to a .csv from the software Picoscope. The file have to be in the following format:
        
        ```
        Time;Channel A
        (ms);(mV)
        
        -200,00015929;-0,21362960
        -200,00004729;-0,73854790
        ```
        
        ### Arguments
        * -h, --help - Showing a help message with all the available arguments.
        * -i lower upper - Set an interval in the x-axis (time). This can be used to isolate parts of a signal that is of interest.
        * -fff - Used to invoke running a FFT on the given signal.
        * -lp cutoff - Applying a low pass filter on the signal. Can be used to remove high frequency disturbances.
        * -hp cutoff - Applying a high pass filter on the singal. Can be used to remove low frequency disturbances.
        * -bs lower upper - Applying a band stop filter on the signal. Can be used to remove disturbances that is defined by a band in the frequency spectrum.
        * -o - Can be used to set an alternative output folder.
        * --version - Prints the current version of the package.
        
        ### Data files
        This module will work with .csv files as exported from PicoScope 6.14.x.
        
        ## Other
        ### Requirements
        Using pipreqs to generate requirements.txt
        
        ### Docstrings
        Docstrings are following sphinx format according to:
        https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
        
        ### Installation?
        https://github.com/pyinstaller/pyinstaller
        
Keywords: analysis,picoscope
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
