LibreEngineering

Author: Alex Borisov
Contributors: Yuri Bongiorno

Copyright (c) 2010-2012 Alex Borisov

This program is free software: you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation, either
version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see .


*****************************************************************************************
* LibreEngineering - Qt-based Suite of Engineering Calculation Programs *
*****************************************************************************************

FEATURES:

- SI unit converter to NIST Special Publication 811
- Thermowell design calculator to ASME PTC 19.3 TW 2010
- Renewable energy sizing calculator to IEEE and AS/NZS 4509.2
- Cable volt drop calculator to IEC 60287-1-1
- Process conditions converter between Actual/STP/NTP/SATP/ISA/ICAO
- Intrinsically safe parameters verification calculator (TODO)
- Compressor air consumption calculator (TODO)
- Orifice plate sizing calculator (TODO)
- Control and safety valve sizing calculator (TODO)
- Pipe sizing calculator (TODO)

- Video/audio/image codec based on FFMPEG/LibAV
- Russian/Latin keyboard translitirator with spellcheck

- Equipment data stored in SQLite databases
- Written in Python and Qt
- OS independent (tested on Linux and Windows)
- Minimalistic and simplistic approach
- Licensed under GPL3


SPECIAL NOTES

- For Cable, Converter and Energy modules, every time brand, model, property etc. data are
added/edited/deleted, a backup version of the database is stored in the relevant module's
data folder, e.g. ./LibreEngineering/data/cable/cable.sqlite~. To go back to the previous
version of the database, simply delete the existing data base file (e.g. cable.sqlite) and
remove the '~' symbol from the back-up file name.
- It seems there is no SVG support in PortablePython-2.7.3+'s version of Qt.


PREREQUISITES:

- Python-2.7+ (please note Python-3.x was not tested and may not work)
- PyQt-4.7+
- PyEnchant and Myspell dictionaries (required for Translit only)
- PySqlite
- SQLAlchemy

HOW TO INSTALL FOR WINDOWS USERS:
- Python:
- www.python.org/download/
- PortablePython:
- www.portablepython.com/wiki/Download
- Qt: www.riverbankcomputing.co.uk/software/pyqt/download
- For PortablePython on Windows, PyQt has to be installed in ../PortablePython/App
- Make sure PyQt version matches Python version (e.g. if Python-2.7.* is installed,
then install corresponding PyQt-Py2.7-*, otherwise it will not work)
- SQLAlchemy:
- www.sqlalchemy.org/download.html
- Easiest way to install SQLAlchemy in Windows:
1. Download setuptools from http://pypi.python.org/pypi/setuptools#downloads
2. Install setuptools
3. Open command prompt and execute this:
C:\\Scripts\easy_install.exe SQLAlchemy
- PyEnchant:
- packages.python.org/pyenchant/download.html
- To install PyEnchant for Portable Python in Windows, add Python path to Windows Registry by:
1. edit 'version' and 'installpath' in 'add_python_to_registry.py' from scripts folder
2. run 'add_python_to_registry.py' script with Python
- Install dictionaries from LibreOffice:
- www.libreoffice.org/download/
- Copy Russian dictionary files 'ru_RU.aff' and 'ru_RU.dic' from
/libreoffice/share/extensions/dict-ru to
/Lib/site-packages/enchant/share/enchant/myspell

To start LibreEngineering:
- For Linux users: run/open 'libreengineering.pyw' with 'python
- For Windows users: open 'libreengineering.pyw' with 'pythonw.exe'


*****************************************************************************************
* Cable *
*****************************************************************************************

Cable volt drop calculation program is based on AS/NZS 3008.1.1 and IEC 60287-1-1

FEATURES:

- Volt drop calculations
- Earth fault sizing (TODO)
- Cable data
- Add/edit/delete cable data
- View/print/save calculation results
- Save/export as ODT, PDF, HTML, TXT

*****************************************************************************************
* Codec *
*****************************************************************************************

Graphical Interface Wrapper for FFMPEG/LibAV - ultimate video/audio/image codec

FEATURES:

- Video, audio, image codec
- Convert audio/video from/to anything FFMPEG/LibAV support
- Convert/resize/rotate images to PNG/JP(E)G/TIFF/BMP/SVG/PDF etc.
- Multiple file (batch) conversion
- Audio/video presets

NOTE: Linux and Windows versions of ffmpeg/libav use different encoder libraries,
so some options or presets may fail. Check FFMPEG/LibAV supported formats and codecs
for details and enter them manually.

*****************************************************************************************
* Compressor *
*****************************************************************************************

Compressor air consumption calculator

FEATURES:

- TODO

*****************************************************************************************
* Conditions *
*****************************************************************************************

Converts Pressure, Temperature, Flow Rate and Compressibility between Actual,
Standard Temperature and Pressure (STP), Normal Temperature and Pressure (NTP),
Standard Ambient Temperature and Pressure (SATP), International Standard Atmosphere (ISA) and
International Civil Aviation Organization (ICAO) conditions

FEATURES:

- SI System of Units
- STP/NTP/SATP/ISA/ICAO presets
- Absolute or gauge pressures

*****************************************************************************************
* Converter *
*****************************************************************************************

SI unit conversion program is based on the latest standard of International
System of Units (SI) and NIST Special Publication 811.

FEATURES:

- International System of Units (SI) and NIST compliant
- Add/Edit/Delete existing and custom units

*****************************************************************************************
* Energy *
*****************************************************************************************

Renewable energy sizing calculation program is based on AS/NZS 4509.2.

FEATURES:

- Solar panel, gen set (TODO) and wind turbine generators
- AC and DC loads
- Summer and winter demand
- System pay-off period calculation
- Battery, solar panel, gen set (TODO), wind turbine, regulator and inverter data
- Add/edit/delete battery, solar panel, gen set (TODO), wind turbine, regulator and inverter data
- View/print/save calculation results
- Save/export as ODT, PDF, HTML, TXT
- SI System of Units

*****************************************************************************************
* Hazarea *
*****************************************************************************************

Intrinsically safe parameters verification calculation program is based on
AS/NZS 60079.11 and AS/NZS 60079.14

FEATURES:

- TODO

*****************************************************************************************
* Orifice *
*****************************************************************************************

Orifice plate sizing calculator is based on ISO 5167.2

FEATURES:

- TODO

*****************************************************************************************
* Pipe *
*****************************************************************************************

Pipe errosional velocity sizing calculator

FEATURES:

- TODO

*****************************************************************************************
* Thermowell *
*****************************************************************************************

Thermowell design calculation program is based on ASME PTC 19.3 TW - 2010 and
uses material data from ASME II, ASME VIII, ASME B16.5, ASME B31.1, ASME B31.3,
ASME B36.10 and others. It performs thermowell dimensional verifications, vortex
shedding (wake frequency) calculations, steady-state and dynamic stress calculations
and hydrostatic pressure calculations. Some steel material, flange and pipe data are
provided which can be easily added, edited or deleted. The program performs
calculations in SI units and will perform calculations for flanged and threaded
thermowell types incl. tapered, straight and step shank designs in straight, angle or
elbow installations. It also checks if the thermowell fits in pipe nozzle and
if it meets the tip location criterion.

FEATURES:

- Tapered, straight and step thermowells
- Flanged and threaded connections
- Straight, angle and elbow installations
- Material and flange data up to 500 deg C
- Pipe data up to DN1200
- Add/edit/delete material, flange and pipe data
- View/print/save calculation results
- Save/export as ODT, PDF, HTML, TXT
- SI System of Units

*****************************************************************************************
* Translit *
*****************************************************************************************

Russian/Latin keyboard translation program

FEATURES:

- Russian alphabetic/phonetic and windows keyboard translations
- Rich text editor
- Save/export as ODT, PDF, HTML, TXT
- Print and print preview
- Default Latin keyboard
- Russian pushbuttons
- Spell check

*****************************************************************************************
* Valve *
*****************************************************************************************

Control and safety valve sizing calculator is based on AS 1271.

FEATURES:

- TODO


*****************************************************************************************

I NEED ENGINEERS AND PROGRAMMERS HELP

I would like to add many more engineering calculations, e.g. orifice plate, PSV, control
valve etc. but I am not a process engineer, so making the research and applying correct
formulas is a very time consuming process. I will greatly appreciate anyone's help who
has a process engineering background. Please provide the sizing calculation formulas
so that I can write the calculation module. Any results verification help will be greatly
appreciated.

As I am not a programmer, the code may not be perfect. But I will also greatly appreciate
any help with programming, e.g. making the code better, fixing bugs, adding features.


SPECIAL THANKS TO DEVELOPERS AND SUPPORTERS:

- Yuri Bongiorno for support with Codec
- WinFF for Ffmpeg presets
- OpenClipart for artwork
- Python, Qt, PyQt, PyEnchant, LibreOffice, SQLAlchemy, SQLite
- Joakim Low from PythonWare for PortablePython Windows Registry script
- sqlitefktg4sa for SQLite Foreign Key Trigger Generator for SQLAlchemy


THINGS I WANT TO DO:

- Thermowell select image - draw TW in pipe based on entered dimensions
- Codec - add encypted DVD transcoding
- Show calculation formulas in results (MathML?)
- Add internationalization and translations
- Module settings management
- Port to Python3

- Added volume setting to Codec