From f7972a1635afae070a580a8a04ad11438a117837 Mon Sep 17 00:00:00 2001 From: Jeff MacKinnon Date: Tue, 10 Feb 2026 17:44:13 -0400 Subject: [PATCH] Added Readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f374598 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# JMK Engineering Python Tools + +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. + +The library is broken into sections, with more being added later, including circuits and pv. + +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. + +Use the example python notebook to get started. + +## What we're missing + +Tests, I haven't written any real tests for this set of libraries, yet. That will be coming soon, probably the next time that we have a slow time. + + +# Limitations + +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. \ No newline at end of file