Merge pull request #109 from engineerjoe440/dev/explore-#108

Prepare for 0.3.0 Release... Ready or Not...

.github/workflows/pytest.yml

@@ -25,7 +25,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        if [ -f test/pytestrequires.txt ]; then pip install -r test/pytestrequires.txt; fi
+        if [ -f test/requirements.txt ]; then pip install -r test/requirements.txt; fi
         pip install .
         python3 -c "import electricpy; print('electricpy.__file__')"
     - name: Test with pytest

.github/workflows/sphinx.yml

@@ -23,7 +23,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           cp logo/ElectricpyLogo.svg docsource/static/ElectricpyLogo.svg
-          pip install -r docsource/sphinxrequires.txt
+          pip install -r docsource/requirements.txt
       - name: Build Sphinx docs
         if: success()
         run: |
@@ -33,7 +33,7 @@ jobs:
       - name: Generate Coverage Badge
         if: success()
         run: |
-          pip install -r test/pytestrequires.txt
+          pip install -r test/requirements.txt
           coverage run --source=./electricpy -m pytest
           coverage-badge -o docs/html/coverage.svg
 

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docsource/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docsource/requirements.txt

README.md

@@ -54,10 +54,11 @@ notebooks!)
 
 ## Installing / Getting Started
 
-1. Install ElectricPy with `pip`
+1. ElectricPy has a few basic installation options for use with `pip`. For most
+common users, use the following command to install ElectricPy with `pip`
 
 ```
-pip install electricpy
+pip install electricpy[full]
 ```
 
 2. Check installation success in Python environment:
@@ -103,8 +104,17 @@ and installing locally.
 - [matplotlib](https://matplotlib.org/)
 - [SciPy](https://scipy.org/)
 - [SymPy](https://www.sympy.org/en/index.html)
+
+#### Optional Dependencies
+
+For numerical analysis (install with `pip install electricpy[numerical]`):
+
 - [numdifftools](https://numdifftools.readthedocs.io/en/latest/)
 
+For fault analysis (install with `pip install electricpy[fault]`)
+
+- [arcflash](https://github.com/LiaungYip/arcflash)
+
 
 ## Get Involved / Contribute
 
@@ -153,7 +163,6 @@ opportunity to take advantage of this project.
 For more information regarding this resource, please contact Joe Stanley
 
 - <[email protected]>
-- <[email protected]>
 
 ## License and Usage
 

cspell.json

@@ -0,0 +1,23 @@
+{
+    "version": "0.2",
+    "ignorePaths": [],
+    "dictionaryDefinitions": [],
+    "dictionaries": [],
+    "words": [
+        "electricpy",
+        "epmath",
+        "fsolve",
+        "matplotlib",
+        "parallelz",
+        "phasor",
+        "phasorlist",
+        "phasorplot",
+        "phasors",
+        "powerset",
+        "pyplot",
+        "scipy",
+        "visu"
+    ],
+    "ignoreWords": [],
+    "import": []
+}

docsource/conf.py

@@ -83,7 +83,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', "sphinxrequires.txt"]
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', "requirements.txt"]
 
 templates_path = ["_templates"]
 

electricpy/__init__.py

@@ -13,26 +13,22 @@
 ################################################################################
 
 
-from .version import NAME, VERSION
 import cmath as _c
 from inspect import getframeinfo as _getframeinfo
 from inspect import stack as _stack
 from warnings import showwarning as _showwarning
 
 import matplotlib.pyplot as _plt
-# Import Supporting Modules
 import numpy as _np
 from scipy.integrate import quad as integrate
 
-# Import Submodules
+from .version import NAME, VERSION
 from .constants import *
 from .phasors import phasor, parallelz
 
 __version__ = VERSION
 
 # Define Cycle Time Function
-
-
 def tcycle(ncycles=1, freq=60):
     r"""
     Time of Electrical Cycles.

electricpy/bode.py

@@ -8,12 +8,12 @@
 
 from cmath import exp as _exp
 
-# Import External Dependencies
+
 import matplotlib.pyplot as _plt
 import numpy as _np
 import scipy.signal as _sig
 from numpy import pi as _pi
-# Import Local Dependencies
+
 from electricpy.math import convolve
 
 # Define System Conditioning Function

electricpy/constants.py

@@ -7,7 +7,6 @@
 """
 ################################################################################
 
-# Import Supporting Dependencies
 import numpy as _np
 import cmath as _c
 

electricpy/conversions.py

@@ -12,7 +12,6 @@
 """
 ################################################################################
 
-# Import Local Requirements
 from electricpy.constants import WATTS_PER_HP, Aabc, A012, KWH_PER_BTU
 
 # Import Required Packages

electricpy/fault.py

@@ -6,14 +6,12 @@
 """
 ################################################################################
 
-# Import Necessary Dependencies
 import numpy as _np
 import matplotlib.pyplot as _plt
 from scipy.optimize import fsolve as _fsolve
 
-# Import Local Dependencies
-from .constants import *
-from .conversions import seq_to_abc
+from electricpy.constants import *
+from electricpy.conversions import seq_to_abc
 
 
 def _phaseroll(M012, reference):

electricpy/latex.py

@@ -15,7 +15,6 @@
 
 import cmath as _c
 
-# Import Required Packages
 import numpy as _np
 
 

electricpy/machines.py

@@ -6,13 +6,11 @@
 """
 ################################################################################
 
-# Required Imports
 import cmath as _c
 import numpy as _np
 from scipy.optimize import fsolve as _fsolve
 
-# Import Locals
-from .phasors import compose
+from electricpy.phasors import compose
 
 
 # Define Transformer Short-Circuit/Open-Circuit Function

electricpy/math.py

@@ -13,7 +13,6 @@
 """
 ################################################################################
 
-# Import Required Packages
 import numpy as _np
 import scipy.signal as _sig
 from scipy.integrate import quad as integrate

electricpy/passive.py

@@ -5,6 +5,7 @@
 Filled with methods related capacitors.
 """
 ################################################################################
+
 import numpy as _np
 
 

electricpy/phasors.py

@@ -13,7 +13,6 @@
 """
 ################################################################################
 
-# Import Required Packages
 import numpy as _np
 import cmath as _c
 

electricpy/thermal.py

@@ -7,12 +7,9 @@
 """
 ################################################################################
 
-
-# Import Supporting Modules
 import numpy as _np
 
-# Import Submodules
-from .constants import *
+from electricpy.constants import *
 
 # Define Cold-Junction-Voltage Calculator
 def coldjunction(Tcj, coupletype="K", To=None, Vo=None, P1=None, P2=None,

electricpy/version.py

@@ -7,5 +7,6 @@
 This file is to keep track of Name, Current Version of electricpy for CI and CD
 """
 ################################################################################
+
 NAME = "electricpy"
-VERSION = "0.3.0"
+VERSION = "0.3.0"