Modest collection of electrical energy calculation tools.
Project description
energy-tools
Modest collection of electrical energy calculation tools.
Note: This repo is currently being translated to English and under heavy alterations to make it suitable for PyPi. Major changes are to be expected.
Installation
Requirements
Basic requirements:
- Python 3.6+;
- numpy.
Development requirements:
- pre-commit;
- pytest;
- twine.
Installation energy-tools
With pip
- Open a command prompt (e.g. Start > cmd on windows systems);
- Install energy-tools by running:
pip install energy-tools
Without pip
If you don’t have internet access on your system or don’t want to use pip for some other reason, energy-tools can also be installed without using pip:
-
Download and unzip the current energy-tools distribution from PyPi under “Download files”.
-
Open a command prompt (e.g. Start > cmd on Windows) and navigate to the folder that contains the setup.py file with the command cd :
cd %path_to_energy-tools%\energy-tools-x.x.x\
Install energy-tools by running :
python setup.py install
Development version
To install the latest development version of energy-tools from GitLab, simply follow these steps:
-
Download and install git.
-
Open a git shell and navigate to the directory where you want to keep your energy-tools files.
-
Run the following git command:
-
Navigate inside the repository and check out the develop branch:
cd energy-tools git checkout develop
-
Install Black using pre-commit:
pre-commit install
-
Set your Python path to the outer energy-tools folder (/energy-tools, NOT energy-tools/energy-tools).
-
If necessary, install missing dependencies via pip install (see Development requirements above).
Test your installation
To test your installed development version, run pytest from the energy-tools' base directory:
pytest
Contributing
If you wish to contribute, please follow the development version instructions above and refer to the project's contribution guide.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for energy_tools-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c73ed2c34cd655328eb540d8b25197965d18c7e5d4e9a92bbff89e81c6216046 |
|
MD5 | 725703bcbb04597060cda17f77d9d692 |
|
BLAKE2b-256 | a6cda270992863296b1558aca07b28ff2d76d4958717f144369cf0e6d866dba0 |