started migrating to md documentation

Author: engineerjoe440

.github/workflows/sphinx.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v3
         with:
-          python-version: "3.11"
+          python-version: "3.12"
       # I don't know where the "run" thing is documented.
       - name: Install dependencies
         run: |

docsource/additionalresources.md

@@ -0,0 +1,24 @@
+# Additional Resources
+
+
+## Generic and Data Science
+
+* NumPy: https://numpy.org/
+* SciPy: https://scipy.org/
+* Matplotlib: https://matplotlib.org/
+* SymPy: https://www.sympy.org/en/index.html
+* Pyomo: https://www.pyomo.org/
+* Pint: https://pint.readthedocs.io/en/stable/
+* numdifftools: https://numdifftools.readthedocs.io/en/latest/
+
+## Electrical Engineering Focus
+
+* Python COMTRADE File Interpreter: https://github.com/dparrini/python-comtrade    
+* Python COMTRADE Writer: https://github.com/relihanl/comtradehandlers
+* Arc Flash Calculator: https://github.com/LiaungYip/arcflash
+* PandaPower: https://www.pandapower.org/start/
+* PyPSA: https://github.com/PyPSA/PyPSA
+* PyPower (no longer supported): https://pypi.org/project/PYPOWER/
+* minpower: http://adamgreenhall.github.io/minpower/index.html
+* oemof (Open Energy MOdeling Framework): https://oemof.org/
+* PowerGAMA: https://bitbucket.org/harald_g_svendsen/powergama/wiki/Home

docsource/additionalresources.rst

@@ -38,7 +38,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'electricpy'
-copyright = '2022, Joe Stanley'
+copyright = '2026, Joe Stanley'
 author = 'Joe Stanley'
 
 # The full version, including alpha/beta/rc tags
@@ -56,8 +56,6 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.autosummary',
     'sphinx.ext.viewcode',
-    'numpydoc',
-    'sphinx_git',
     'myst_parser',
     'sphinx_immaterial',
 ]

docsource/changes.rst

@@ -0,0 +1,22 @@
+# Constants
+
+In addition to the variety of funcitons provided, several common, and useful,
+constants are provided to simplify arithmetic.
+
+
+| Name           | Value                                                          |
+|----------------|----------------------------------------------------------------|
+| `pi`           | π (derived from numpy.pi)                        |
+| `a`            | :math:`1\angle{120}`                     |
+| `p`            | 10^-12 (pico)                        |
+| `n`            | 10^-9 (nano)                     |
+| `u`            | 10^-6 (micro)                        |
+| `m`            | 10^-3 (mili)                     |
+| `k`            | 10^3 (kila)                      |
+| `M`            | 10^6 (mega)                      |
+| `G`            | 10^9 (giga)                      |
+| `u0`           | :math:`µ0` (mu-not)       4πE-7                      |
+| `e0`           | :math:`ε0` (epsilon-not)  8.854E-12                      |
+| `carson_r`     | 9.869e-7 (Carson's Ristance Constant)                        |
+| `WATTS_PER_HP` | 745.699872                       |
+| `KWH_PER_BTU`  | 3412.14                      |

docsource/conf.py

@@ -36,7 +36,6 @@ Contents:
    electricpyapi
    constants
    additionalresources
-   changes
    Github <https://github.com/engineerjoe440/ElectricPy>
    PyPI <https://pypi.org/project/electricpy>