Metadata-Version: 1.2
Name: pyAbacus
Version: 1.1.0
Summary: Build to simplify the usage of Tausands tools.
Home-page: https://github.com/Tausand-dev/PyAbacus
Author: Juan Barbosa
Author-email: js.barbosa10@uniandes.edu.co
Maintainer: David Guzman
Maintainer-email: da.guzman@outlook.com
License: GPL
Description: # pyAbacus
        
        pyAbacus was built to simplify the usage of Tausand Abacus family of coincidence counters, providing a library aimed to interface these devices using Python coding.
        
        Written in Python3, pyAbacus relies on the following modules:
        - pyserial
        
        
        ## Installation
        `pyAbacus` can be installed using `pip` as: 
        ```
        pip install pyAbacus
        ```
        
        Or from GitHub
        ```
        pip install git+https://github.com/Tausand-dev/PyAbacus.git
        ```
        
        ## For developers
        ### Creating a virtual environment
        Run the following code to create a virtual environment called `.venv`
        ```
        python -m venv .venv
        ```
        
        #### Activate
        - On Unix systems:
        ```
        source .venv/bin/activate
        ```
        - On Windows:
        ```
        .venv\Scripts\activate
        ```
        
        #### Deactivate
        ```
        deactivate
        ```
        
        ### Installing packages
        After the virtual environment has been activated, install required packages by using:
        ```
        python -m pip install -r requirements.txt
        ```
        
        ### Building docs
        Run 
        ```
        make <command>
        ```
        Where `<command>` is one of the following:
        - `latexpdf`
        - `html`
Keywords: example documentation tutorial
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
