Getting Started
===============

Installation
------------

There are (atleast) two ways to install this module.

1. Install using pip in your current Python environment
2. Download the repository and put `pyvib` folder in your project

Pip install
^^^^^^^^^^^

Within your current Python environment (either global, through `virtualenv`, or `Anaconda`), run the following code to install from the git repository:

.. code-block::

    pip install git+https://github.com/andrek10/bearing-vibration-diagnostics-toolbox.git@master

This will install PyVib to your activated environment, including all the dependencies.

Project install
^^^^^^^^^^^^^^^

The repository can be cloned or downloaded, and then put the `pyvib` folder in your project folder.

To install the required packages, you may use `pip` to install them.
Navigate to the `pyvib` folder and run the following command:

.. code-block::

    pip install -r requirements.txt

Example
-------

Here follows an example on running some of the code in the repository.

For this example, we will use the bearing simulator to make some signals, and perform a diagnosis.

.. literalinclude:: ../examples/diagnosis.py
   :language: python