.. _module:

The Rotor Balancing Module
--------------------------

The original attempt by me was to create a single python module that
  takes user variables and give results in an easy way that the
  balancing personnel does not need heavy knowledge in programming or
  python language.
This module is still available in
  `Rotor Module <https://github.com/MagedMohamedTurk/Turbomachinery-Rotors-Balancing/tree/master/Rotor_Balance_module>`__ and in order to use it: 

1. Clone the repo to your local machine.
   
``$ git clone https://github.com/MagedMohamedTurk/Turbomachinery-Rotors-Balancing``


2. ``$ cd Rotor_Balance_Module`` 

3. `Optional` create an isolated environment for python 3.8. (for Anaconda users.)
  
``e.g. $ conda create -n myenv python=3.8``) 

4. Install required packages (cvxpy - panadas - click)
  
``$ pip install -r requirement.txt`` 

5. Run the program:
``$ python -m Rotor_Balancing``