# UliEngineering
[![Unit tests](https://github.com/ulikoehler/UliEngineering/actions/workflows/test.yml/badge.svg)](https://github.com/ulikoehler/UliEngineering/actions/workflows/test.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/f59d862b25524914b29ec5f0c0b80e7f)](https://www.codacy.com/gh/ulikoehler/UliEngineering/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ulikoehler/UliEngineering&utm_campaign=Badge_Grade) [![codecov](https://codecov.io/gh/ulikoehler/UliEngineering/branch/master/graph/badge.svg?token=qnmVG2tYQq)](https://codecov.io/gh/ulikoehler/UliEngineering) [![Code Climate](https://codeclimate.com/github/ulikoehler/UliEngineering/badges/gpa.svg)](https://codeclimate.com/github/ulikoehler/UliEngineering) ![License](https://img.shields.io/github/license/ulikoehler/UliEngineering.svg)
A Python3 library for:
- Data science
- Electronics Engineering
- Specialized algorithms
- Physics
which contains a collection of functions I haven't found elsewhere.
Some algorithms have also been accepted on my blog [https://techoverflow.net/](https://techoverflow.net/)
Pull requests and bugreports of any kind are happily accepted.
## Installation
Run this command on your favourite shell:
```sh
sudo pip3 install UliEngineering
```
In order to install the latest bleeding-edge version, use:
```sh
sudo pip3 install git+https://github.com/ulikoehler/UliEngineering.git
```
We *highly recommend* you also install scipy:
```sh
sudo pip3 install scipy
```
(you can also use `sudo apt install python3-scipy` on Debian-based Linux distros).
While *scipy* is technically optional and listed as an optional dependency, many UliEngineering modules can't be used without it, including (might not be complete!):
* UliEngineering.Length
* UliEngineering.SignalProcessing.Interpolation
* UliEngineering.SignalProcessing.Correlation
* UliEngineering.Physics.JohnsonNyquistNoise
* Some functions in UliEngineering.SignalProcessing.Simulation
* Some functions in UliEngineering.SignalProcessing.Selection
After that you can use UliEngineering from any Python3 instance. Example:
```
$ python3
Python 3.5.2 (default, Nov 17 2016, 17:05:23)
[GCC 5.4.0 20160609] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from UliEngineering.EngineerIO import *
>>> format_value(0.015, "V")
'15.0 mV'
```
## Getting started
On [my blog](https://techoverflow.net), I've posted several easy-to-use examples on how to solve real-world problems using UliEngineering:
- [Normalizing electronics engineering value notations using Python](https://techoverflow.net/2015/06/09/normalizing-electronics-engineering-value-notations-using-python/)
- [Finding the nearest E96 resistor value in Python](https://techoverflow.net/2015/05/19/finding-the-nearest-e96-resistor-value-in-python/)
- [Easy zero crossing detection in Python using UliEngineering](https://techoverflow.net/2018/12/31/easy-zero-crossing-detection-in-python-using-uliengineering/)
- [Easily generate sine/cosine wave test data in Python using UliEngineering](https://techoverflow.net/2018/12/31/easily-generate-sine-cosine-wave-data-in-python-using-uliengineering/)
- [Easily generate square/triangle/sawtooth/inverse sawtooth waveform data in Python using UliEngineering](https://techoverflow.net/2018/12/31/easily-generate-square-triangle-sawtooth-inverse-sawtooth-waveform-data-in-python-using-uliengineering/)
- [Easily compute & visualize FFTs in Python using UliEngineering](https://techoverflow.net/2018/12/31/easily-compute-visualize-ffts-in-python-using-uliengineering/)
- [Computing resistor power dissipation in Python using UliEngineering](https://techoverflow.net/2019/05/09/computing-the-temperature-under-load-of-your-electronics-components-in-python-using-uliengineering/)
- [Computing crystal load capacitance using Python & UliEngineering](https://techoverflow.net/2019/05/10/computing-crystal-load-capacitance-using-python-uliengineering/)
- [How to convert Celsius/Fahrenheit/Kelvin temperatures in Python using UliEngineering](https://techoverflow.net/2019/05/10/how-to-convert-celsius-fahrenheit-kelvin-temperatures-in-python-using-uliengineering/)
- [How to get unit/resolution of NumPy np.timedelta64 object](https://techoverflow.net/2019/05/13/how-to-get-unit-resolution-of-numpy-np-timedelta64-object/)
- [How to get unit/resolution of NumPy np.datetime64 object](https://techoverflow.net/2019/05/13/how-to-get-unit-resolution-of-numpy-np-datetime64-object/)
- [How to iterate all days of year using Python](https://techoverflow.net/2019/05/16/how-to-iterate-all-days-of-year-using-python/)
- [How to get number of days in month in Python](https://techoverflow.net/2019/05/16/how-to-get-number-of-days-in-month-in-python/)
- [How to compute candelas from lumens by apex angle](https://techoverflow.net/2019/08/19/lumen-to-candela-online-calculator-python-code/)
- [How to compute resistor voltage divider ratio using Python](https://techoverflow.net/2021/12/16/how-to-compute-resistor-voltage-divider-ratio-using-python/)
- [How to generate datetime for every hour on a given day in Python](https://techoverflow.net/2022/06/19/how-to-generate-datetime-for-every-hour-on-a-given-day-in-python/)
- [How to generate datetime for every minute on a given day in Python](https://techoverflow.net/2022/06/19/how-to-generate-datetime-for-every-minute-on-a-given-day-in-python/)
- [How to generate datetime for every second on a given day in Python](https://techoverflow.net/2022/06/19/how-to-generate-datetime-for-every-second-on-a-given-day-in-python/)
- [How to compute MRI Larmor frequency for a given magnetic field using Pythonf](https://techoverflow.net/2023/02/04/how-to-compute-mri-larmor-frequency-for-a-given-magnetic-field-using-python/)
- [How to compute voltage divider output voltage using Python](https://techoverflow.net/2023/02/05/how-to-compute-voltage-divider-output-voltage-using-python/)
- [How to format axis as dB (decibel) using matplotlib](https://techoverflow.net/2023/03/13/how-to-format-axis-as-db-decibel-using-matplotlib/)
- [How to compute Buck/Boost/LDO output voltage by feedback resistors using Python](https://techoverflow.net/2023/04/09/how-to-compute-buck-boost-ldo-output-voltage-by-feedback-resistors-using-python/)
- [How to compute the weight of a titanium or stainless steel rod using UliEngineering in Python](https://techoverflow.net/2023/05/21/how-to-compute-the-weight-of-a-titanium-or-stainless-steel-rod-using-uliengineering-in-python/)
- [How to compute non-inverting OpAmp amplifier gain using UliEngineering in Python](https://techoverflow.net/2023/09/18/how-to-compute-non-inverting-opamp-amplifier-gain-using-uliengineering-in-python/)
- [How to generate filename with date & time in Python](https://techoverflow.net/2022/09/02/how-to-generate-filename-with-date-time-in-python/)
## Testing
In order to run the unit tests, first install tox:
```sh
pip install --user tox
```
and then just run it in the root directory of the cloned repository
```sh
tox
```
Raw data
{
"_id": null,
"home_page": "https://techoverflow.net/",
"name": "UliEngineering",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "electronics, engineering, computational tools",
"author": "Uli K\u00f6hler",
"author_email": "ukoehler@techoverflow.net",
"download_url": "https://files.pythonhosted.org/packages/3c/e4/47f90ce88247face6919c8b70c744ac294a545f229fc0e114e2e690c296c/uliengineering-0.4.21.tar.gz",
"platform": null,
"description": "# UliEngineering\n\n[![Unit tests](https://github.com/ulikoehler/UliEngineering/actions/workflows/test.yml/badge.svg)](https://github.com/ulikoehler/UliEngineering/actions/workflows/test.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/f59d862b25524914b29ec5f0c0b80e7f)](https://www.codacy.com/gh/ulikoehler/UliEngineering/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ulikoehler/UliEngineering&utm_campaign=Badge_Grade) [![codecov](https://codecov.io/gh/ulikoehler/UliEngineering/branch/master/graph/badge.svg?token=qnmVG2tYQq)](https://codecov.io/gh/ulikoehler/UliEngineering) [![Code Climate](https://codeclimate.com/github/ulikoehler/UliEngineering/badges/gpa.svg)](https://codeclimate.com/github/ulikoehler/UliEngineering) ![License](https://img.shields.io/github/license/ulikoehler/UliEngineering.svg) \n\nA Python3 library for:\n - Data science\n - Electronics Engineering\n - Specialized algorithms\n - Physics\nwhich contains a collection of functions I haven't found elsewhere.\nSome algorithms have also been accepted on my blog [https://techoverflow.net/](https://techoverflow.net/)\n\nPull requests and bugreports of any kind are happily accepted.\n\n## Installation\n\nRun this command on your favourite shell:\n\n```sh\nsudo pip3 install UliEngineering\n```\n\nIn order to install the latest bleeding-edge version, use:\n\n```sh\nsudo pip3 install git+https://github.com/ulikoehler/UliEngineering.git\n```\n\nWe *highly recommend* you also install scipy:\n```sh\nsudo pip3 install scipy\n```\n(you can also use `sudo apt install python3-scipy` on Debian-based Linux distros).\n\nWhile *scipy* is technically optional and listed as an optional dependency, many UliEngineering modules can't be used without it, including (might not be complete!):\n\n * UliEngineering.Length\n * UliEngineering.SignalProcessing.Interpolation\n * UliEngineering.SignalProcessing.Correlation\n * UliEngineering.Physics.JohnsonNyquistNoise\n * Some functions in UliEngineering.SignalProcessing.Simulation\n * Some functions in UliEngineering.SignalProcessing.Selection\n\nAfter that you can use UliEngineering from any Python3 instance. Example:\n\n```\n$ python3\nPython 3.5.2 (default, Nov 17 2016, 17:05:23) \n[GCC 5.4.0 20160609] on linux\nType \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n>>> from UliEngineering.EngineerIO import *\n>>> format_value(0.015, \"V\")\n'15.0 mV'\n```\n\n## Getting started\n\nOn [my blog](https://techoverflow.net), I've posted several easy-to-use examples on how to solve real-world problems using UliEngineering:\n - [Normalizing electronics engineering value notations using Python](https://techoverflow.net/2015/06/09/normalizing-electronics-engineering-value-notations-using-python/)\n - [Finding the nearest E96 resistor value in Python](https://techoverflow.net/2015/05/19/finding-the-nearest-e96-resistor-value-in-python/)\n - [Easy zero crossing detection in Python using UliEngineering](https://techoverflow.net/2018/12/31/easy-zero-crossing-detection-in-python-using-uliengineering/)\n - [Easily generate sine/cosine wave test data in Python using UliEngineering](https://techoverflow.net/2018/12/31/easily-generate-sine-cosine-wave-data-in-python-using-uliengineering/)\n - [Easily generate square/triangle/sawtooth/inverse sawtooth waveform data in Python using UliEngineering](https://techoverflow.net/2018/12/31/easily-generate-square-triangle-sawtooth-inverse-sawtooth-waveform-data-in-python-using-uliengineering/)\n - [Easily compute & visualize FFTs in Python using UliEngineering](https://techoverflow.net/2018/12/31/easily-compute-visualize-ffts-in-python-using-uliengineering/)\n - [Computing resistor power dissipation in Python using UliEngineering](https://techoverflow.net/2019/05/09/computing-the-temperature-under-load-of-your-electronics-components-in-python-using-uliengineering/)\n - [Computing crystal load capacitance using Python & UliEngineering](https://techoverflow.net/2019/05/10/computing-crystal-load-capacitance-using-python-uliengineering/)\n - [How to convert Celsius/Fahrenheit/Kelvin temperatures in Python using UliEngineering](https://techoverflow.net/2019/05/10/how-to-convert-celsius-fahrenheit-kelvin-temperatures-in-python-using-uliengineering/)\n - [How to get unit/resolution of NumPy np.timedelta64 object](https://techoverflow.net/2019/05/13/how-to-get-unit-resolution-of-numpy-np-timedelta64-object/)\n - [How to get unit/resolution of NumPy np.datetime64 object](https://techoverflow.net/2019/05/13/how-to-get-unit-resolution-of-numpy-np-datetime64-object/)\n - [How to iterate all days of year using Python](https://techoverflow.net/2019/05/16/how-to-iterate-all-days-of-year-using-python/)\n - [How to get number of days in month in Python](https://techoverflow.net/2019/05/16/how-to-get-number-of-days-in-month-in-python/)\n - [How to compute candelas from lumens by apex angle](https://techoverflow.net/2019/08/19/lumen-to-candela-online-calculator-python-code/)\n - [How to compute resistor voltage divider ratio using Python](https://techoverflow.net/2021/12/16/how-to-compute-resistor-voltage-divider-ratio-using-python/)\n - [How to generate datetime for every hour on a given day in Python](https://techoverflow.net/2022/06/19/how-to-generate-datetime-for-every-hour-on-a-given-day-in-python/)\n - [How to generate datetime for every minute on a given day in Python](https://techoverflow.net/2022/06/19/how-to-generate-datetime-for-every-minute-on-a-given-day-in-python/)\n - [How to generate datetime for every second on a given day in Python](https://techoverflow.net/2022/06/19/how-to-generate-datetime-for-every-second-on-a-given-day-in-python/)\n - [How to compute MRI Larmor frequency for a given magnetic field using Pythonf](https://techoverflow.net/2023/02/04/how-to-compute-mri-larmor-frequency-for-a-given-magnetic-field-using-python/)\n - [How to compute voltage divider output voltage using Python](https://techoverflow.net/2023/02/05/how-to-compute-voltage-divider-output-voltage-using-python/)\n - [How to format axis as dB (decibel) using matplotlib](https://techoverflow.net/2023/03/13/how-to-format-axis-as-db-decibel-using-matplotlib/)\n - [How to compute Buck/Boost/LDO output voltage by feedback resistors using Python](https://techoverflow.net/2023/04/09/how-to-compute-buck-boost-ldo-output-voltage-by-feedback-resistors-using-python/)\n - [How to compute the weight of a titanium or stainless steel rod using UliEngineering in Python](https://techoverflow.net/2023/05/21/how-to-compute-the-weight-of-a-titanium-or-stainless-steel-rod-using-uliengineering-in-python/)\n - [How to compute non-inverting OpAmp amplifier gain using UliEngineering in Python](https://techoverflow.net/2023/09/18/how-to-compute-non-inverting-opamp-amplifier-gain-using-uliengineering-in-python/)\n - [How to generate filename with date & time in Python](https://techoverflow.net/2022/09/02/how-to-generate-filename-with-date-time-in-python/)\n\n## Testing\n\nIn order to run the unit tests, first install tox:\n\n```sh\npip install --user tox\n```\n\nand then just run it in the root directory of the cloned repository\n\n```sh\ntox\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Computational tools for electronics engineering",
"version": "0.4.21",
"project_urls": {
"Homepage": "https://techoverflow.net/"
},
"split_keywords": [
"electronics",
" engineering",
" computational tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5341cc910c23dde9a065ee2a8397c785d5333d444877925ed2abbd03f689ac4",
"md5": "5b1a8496f8a22c2dd808f2d38d6ba379",
"sha256": "585234660fb353b0a7ad11d82d802b32373a3767e04dc3adcf24f388b8d2df71"
},
"downloads": -1,
"filename": "uliengineering-0.4.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b1a8496f8a22c2dd808f2d38d6ba379",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 110405,
"upload_time": "2024-11-07T01:04:11",
"upload_time_iso_8601": "2024-11-07T01:04:11.548929Z",
"url": "https://files.pythonhosted.org/packages/e5/34/1cc910c23dde9a065ee2a8397c785d5333d444877925ed2abbd03f689ac4/uliengineering-0.4.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ce447f90ce88247face6919c8b70c744ac294a545f229fc0e114e2e690c296c",
"md5": "125f7f2414d58370b46d0ff6f491241b",
"sha256": "d5cef6550608819661fe1add21095f5c1e0dd49127aa99467e042e6d15609c88"
},
"downloads": -1,
"filename": "uliengineering-0.4.21.tar.gz",
"has_sig": false,
"md5_digest": "125f7f2414d58370b46d0ff6f491241b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 84779,
"upload_time": "2024-11-07T01:04:13",
"upload_time_iso_8601": "2024-11-07T01:04:13.428292Z",
"url": "https://files.pythonhosted.org/packages/3c/e4/47f90ce88247face6919c8b70c744ac294a545f229fc0e114e2e690c296c/uliengineering-0.4.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 01:04:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "uliengineering"
}