JMK_Engineering_Inc/JMKTools
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Updated to match what the current module looks like

Browse source
This commit is contained in:
Jeff MacKinnon 2026-02-15 17:23:37 -04:00
parent 16666d98d0
commit 0b360c9e0e
1 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -2,13 +2,16 @@
or JMKTools for short.
I don't know if this should be called a library or a set of modules. What it is, is a set of functions that replace calculations that I do on a weekly basis.
What it is, is a set of functions that replace calculations that I do on a weekly basis.
The library is broken into sections, with more being added later, including circuits and pv.
The library is broken into sections, including
Some of these libraries rely on publicly accessible information, including manufacturer data sheets. The libraries that rely on copyrighted information you need to make sure that you have a copy of the standard, code, etc before initializing the software.
- general
- circuits
- grounding
- and pv.
Use the example python notebook to get started.
Some of these modulesrely on publicly accessible information, including manufacturer data sheets.
## What we're missing
@ -19,8 +22,14 @@ Tests, I haven't written any real tests for this set of libraries, yet. That wil
Currently the tools use the CEC, in most cases this will match the NEC, but something we are working on is updating that so we can select from which code version should be used for the calculation.
Another limitation is the use of SQL databases. This limits its functionality as a module, but my ability with pandas dataframe lookups is very weak. If anyone wants to make the changes and submit a pull request, we can develop that method on a different branch and test it to the main in the near future.
# Future Features
There are a lot of different features that I am planning, including building a web app that will allow this tool to be easily used from a browser, but before I get to that the largest feature that I need to figure out is how to install this as a module so that it can be called from any script that you want.
- [x] Web app (this is started at [Digital Power Systems Toolbox](http://toolbox.digitalpowersystems.net))
- [x] Installable package [The first releases are here](https://git.jmkengineering.com/JMK_Engineering_Inc/JMKTools/releases)
- [ ] Add NEC to the calculations
- [ ] Re-do and add PV functions to the package.
- [ ] Detailed documentation (the source is started in this repo)
- [ ] Electrical Safety Calculations
- [ ] Basic Load flow tools
- [ ] Basic Shortcircuit tools