diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 46b285e..d706215 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -4,6 +4,7 @@ on: push: branches: [main] paths-ignore: + - 'src/*' - '*.md' - 'README*' - 'LICENSE' @@ -13,6 +14,7 @@ on: pull_request: branches: [main] paths-ignore: + - 'src/*' - '*.md' - 'README*' - 'LICENSE' diff --git a/docs/.buildinfo b/docs/.buildinfo index c4104e3..994ddb4 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 4566d29b1ee0401b1bdd5694fa563ac7 +config: 18dd5f2e14df97ffae178207af6e4a3e tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/.doctrees/api/index.doctree b/docs/.doctrees/api/index.doctree index 992755d..ec29096 100644 Binary files a/docs/.doctrees/api/index.doctree and b/docs/.doctrees/api/index.doctree differ diff --git a/docs/.doctrees/api/thevenin/index.doctree b/docs/.doctrees/api/thevenin/index.doctree index cfcdf51..df0b85a 100644 Binary files a/docs/.doctrees/api/thevenin/index.doctree and b/docs/.doctrees/api/thevenin/index.doctree differ diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle index 15d03bf..b0f27fc 100644 Binary files a/docs/.doctrees/environment.pickle and b/docs/.doctrees/environment.pickle differ diff --git a/docs/.doctrees/examples/example1.doctree b/docs/.doctrees/examples/example1.doctree index eceee11..23e1cdb 100644 Binary files a/docs/.doctrees/examples/example1.doctree and b/docs/.doctrees/examples/example1.doctree differ diff --git a/docs/.doctrees/examples/example2.doctree b/docs/.doctrees/examples/example2.doctree index 2eaa25c..32f5075 100644 Binary files a/docs/.doctrees/examples/example2.doctree and b/docs/.doctrees/examples/example2.doctree differ diff --git a/docs/.doctrees/examples/index.doctree b/docs/.doctrees/examples/index.doctree index ba35247..25645ab 100644 Binary files a/docs/.doctrees/examples/index.doctree and b/docs/.doctrees/examples/index.doctree differ diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree index 5535df7..8a862d4 100644 Binary files a/docs/.doctrees/index.doctree and b/docs/.doctrees/index.doctree differ diff --git a/docs/_modules/thevenin/_experiment.html b/docs/_modules/thevenin/_experiment.html index ddbeac0..04e6b6c 100644 --- a/docs/_modules/thevenin/_experiment.html +++ b/docs/_modules/thevenin/_experiment.html @@ -323,7 +323,8 @@

Source code for thevenin._experiment

-from typing import Callable
+from __future__ import annotations
+from typing import Callable
 
 import numpy as np
 
diff --git a/docs/_modules/thevenin/_ida_solver.html b/docs/_modules/thevenin/_ida_solver.html
index 49d5af2..30a2db1 100644
--- a/docs/_modules/thevenin/_ida_solver.html
+++ b/docs/_modules/thevenin/_ida_solver.html
@@ -323,7 +323,8 @@
                 

Source code for thevenin._ida_solver

-from typing import Callable
+from __future__ import annotations
+from typing import Callable
 
 import numpy as np
 from scikits.odes import dae
diff --git a/docs/_sources/api/thevenin/index.rst.txt b/docs/_sources/api/thevenin/index.rst.txt
index 87cf952..6356d6a 100644
--- a/docs/_sources/api/thevenin/index.rst.txt
+++ b/docs/_sources/api/thevenin/index.rst.txt
@@ -16,9 +16,8 @@ thevenin
 
    Documentation is accessible via Python's ``help()`` function which prints
    docstrings from a package, module, function, class, etc. In addition, you can
-   access the documentation by calling the built-in ``thevenin.docs()`` method to
-   open a local website. The website includes search functionality and examples,
-   beyond the code docstrings.
+   access the documentation by visiting the website, hosted through GitHub pages.
+   The website includes search functionality and examples, beyond the docstrings.
 
    .. rubric:: Viewing documentation using IPython
 
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
index d37d6a2..fa71ed8 100644
--- a/docs/_sources/index.rst.txt
+++ b/docs/_sources/index.rst.txt
@@ -54,7 +54,7 @@ Summary
          A great place to learn how to use the package 
          and expand your skills.
 
-         .. image:: _static/examples.svg
+         .. image:: static/examples.svg
             :class: bg-transparent
             :align: center
             :height: 75px
@@ -74,7 +74,7 @@ Summary
          Get detailed documentation on all of the 
          modules, functions, classes, etc.
 
-         .. image:: _static/api_reference.svg
+         .. image:: static/api_reference.svg
             :class: bg-transparent
             :align: center
             :height: 75px
diff --git a/docs/static/api_reference.svg b/docs/_static/api_reference.svg
similarity index 100%
rename from docs/static/api_reference.svg
rename to docs/_static/api_reference.svg
diff --git a/docs/static/basic.css b/docs/_static/basic.css
similarity index 100%
rename from docs/static/basic.css
rename to docs/_static/basic.css
diff --git a/docs/static/check-solid.svg b/docs/_static/check-solid.svg
similarity index 100%
rename from docs/static/check-solid.svg
rename to docs/_static/check-solid.svg
diff --git a/docs/static/clipboard.min.js b/docs/_static/clipboard.min.js
similarity index 100%
rename from docs/static/clipboard.min.js
rename to docs/_static/clipboard.min.js
diff --git a/docs/static/contact.svg b/docs/_static/contact.svg
similarity index 100%
rename from docs/static/contact.svg
rename to docs/_static/contact.svg
diff --git a/docs/static/copy-button.svg b/docs/_static/copy-button.svg
similarity index 100%
rename from docs/static/copy-button.svg
rename to docs/_static/copy-button.svg
diff --git a/docs/static/copybutton.css b/docs/_static/copybutton.css
similarity index 100%
rename from docs/static/copybutton.css
rename to docs/_static/copybutton.css
diff --git a/docs/static/copybutton.js b/docs/_static/copybutton.js
similarity index 100%
rename from docs/static/copybutton.js
rename to docs/_static/copybutton.js
diff --git a/docs/static/copybutton_funcs.js b/docs/_static/copybutton_funcs.js
similarity index 100%
rename from docs/static/copybutton_funcs.js
rename to docs/_static/copybutton_funcs.js
diff --git a/docs/static/custom.css b/docs/_static/custom.css
similarity index 100%
rename from docs/static/custom.css
rename to docs/_static/custom.css
diff --git a/docs/static/custom.js b/docs/_static/custom.js
similarity index 100%
rename from docs/static/custom.js
rename to docs/_static/custom.js
diff --git a/docs/static/dark.svg b/docs/_static/dark.svg
similarity index 100%
rename from docs/static/dark.svg
rename to docs/_static/dark.svg
diff --git a/docs/static/design-tabs.js b/docs/_static/design-tabs.js
similarity index 100%
rename from docs/static/design-tabs.js
rename to docs/_static/design-tabs.js
diff --git a/docs/static/doctools.js b/docs/_static/doctools.js
similarity index 100%
rename from docs/static/doctools.js
rename to docs/_static/doctools.js
diff --git a/docs/static/documentation_options.js b/docs/_static/documentation_options.js
similarity index 100%
rename from docs/static/documentation_options.js
rename to docs/_static/documentation_options.js
diff --git a/docs/static/examples.svg b/docs/_static/examples.svg
similarity index 100%
rename from docs/static/examples.svg
rename to docs/_static/examples.svg
diff --git a/docs/static/favicon.ico b/docs/_static/favicon.ico
similarity index 100%
rename from docs/static/favicon.ico
rename to docs/_static/favicon.ico
diff --git a/docs/static/file.png b/docs/_static/file.png
similarity index 100%
rename from docs/static/file.png
rename to docs/_static/file.png
diff --git a/docs/static/get_started.svg b/docs/_static/get_started.svg
similarity index 100%
rename from docs/static/get_started.svg
rename to docs/_static/get_started.svg
diff --git a/docs/static/graphviz.css b/docs/_static/graphviz.css
similarity index 100%
rename from docs/static/graphviz.css
rename to docs/_static/graphviz.css
diff --git a/docs/static/icons.svg b/docs/_static/icons.svg
similarity index 100%
rename from docs/static/icons.svg
rename to docs/_static/icons.svg
diff --git a/docs/static/language_data.js b/docs/_static/language_data.js
similarity index 100%
rename from docs/static/language_data.js
rename to docs/_static/language_data.js
diff --git a/docs/static/light.svg b/docs/_static/light.svg
similarity index 100%
rename from docs/static/light.svg
rename to docs/_static/light.svg
diff --git a/docs/static/minus.png b/docs/_static/minus.png
similarity index 100%
rename from docs/static/minus.png
rename to docs/_static/minus.png
diff --git a/docs/static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css b/docs/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css
similarity index 100%
rename from docs/static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css
rename to docs/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css
diff --git a/docs/static/plus.png b/docs/_static/plus.png
similarity index 100%
rename from docs/static/plus.png
rename to docs/_static/plus.png
diff --git a/docs/static/pygments.css b/docs/_static/pygments.css
similarity index 100%
rename from docs/static/pygments.css
rename to docs/_static/pygments.css
diff --git a/docs/static/scripts/bootstrap.js b/docs/_static/scripts/bootstrap.js
similarity index 100%
rename from docs/static/scripts/bootstrap.js
rename to docs/_static/scripts/bootstrap.js
diff --git a/docs/static/scripts/bootstrap.js.LICENSE.txt b/docs/_static/scripts/bootstrap.js.LICENSE.txt
similarity index 100%
rename from docs/static/scripts/bootstrap.js.LICENSE.txt
rename to docs/_static/scripts/bootstrap.js.LICENSE.txt
diff --git a/docs/static/scripts/bootstrap.js.map b/docs/_static/scripts/bootstrap.js.map
similarity index 100%
rename from docs/static/scripts/bootstrap.js.map
rename to docs/_static/scripts/bootstrap.js.map
diff --git a/docs/static/scripts/pydata-sphinx-theme.js b/docs/_static/scripts/pydata-sphinx-theme.js
similarity index 100%
rename from docs/static/scripts/pydata-sphinx-theme.js
rename to docs/_static/scripts/pydata-sphinx-theme.js
diff --git a/docs/static/scripts/pydata-sphinx-theme.js.map b/docs/_static/scripts/pydata-sphinx-theme.js.map
similarity index 100%
rename from docs/static/scripts/pydata-sphinx-theme.js.map
rename to docs/_static/scripts/pydata-sphinx-theme.js.map
diff --git a/docs/static/searchtools.js b/docs/_static/searchtools.js
similarity index 100%
rename from docs/static/searchtools.js
rename to docs/_static/searchtools.js
diff --git a/docs/static/sphinx-design.min.css b/docs/_static/sphinx-design.min.css
similarity index 100%
rename from docs/static/sphinx-design.min.css
rename to docs/_static/sphinx-design.min.css
diff --git a/docs/static/sphinx_highlight.js b/docs/_static/sphinx_highlight.js
similarity index 100%
rename from docs/static/sphinx_highlight.js
rename to docs/_static/sphinx_highlight.js
diff --git a/docs/static/styles/bootstrap.css b/docs/_static/styles/bootstrap.css
similarity index 100%
rename from docs/static/styles/bootstrap.css
rename to docs/_static/styles/bootstrap.css
diff --git a/docs/static/styles/bootstrap.css.map b/docs/_static/styles/bootstrap.css.map
similarity index 100%
rename from docs/static/styles/bootstrap.css.map
rename to docs/_static/styles/bootstrap.css.map
diff --git a/docs/static/styles/pydata-sphinx-theme.css b/docs/_static/styles/pydata-sphinx-theme.css
similarity index 100%
rename from docs/static/styles/pydata-sphinx-theme.css
rename to docs/_static/styles/pydata-sphinx-theme.css
diff --git a/docs/static/styles/pydata-sphinx-theme.css.map b/docs/_static/styles/pydata-sphinx-theme.css.map
similarity index 100%
rename from docs/static/styles/pydata-sphinx-theme.css.map
rename to docs/_static/styles/pydata-sphinx-theme.css.map
diff --git a/docs/static/styles/theme.css b/docs/_static/styles/theme.css
similarity index 100%
rename from docs/static/styles/theme.css
rename to docs/_static/styles/theme.css
diff --git a/docs/static/vendor/fontawesome/6.5.2/LICENSE.txt b/docs/_static/vendor/fontawesome/6.5.2/LICENSE.txt
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/LICENSE.txt
rename to docs/_static/vendor/fontawesome/6.5.2/LICENSE.txt
diff --git a/docs/static/vendor/fontawesome/6.5.2/css/all.min.css b/docs/_static/vendor/fontawesome/6.5.2/css/all.min.css
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/css/all.min.css
rename to docs/_static/vendor/fontawesome/6.5.2/css/all.min.css
diff --git a/docs/static/vendor/fontawesome/6.5.2/js/all.min.js b/docs/_static/vendor/fontawesome/6.5.2/js/all.min.js
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/js/all.min.js
rename to docs/_static/vendor/fontawesome/6.5.2/js/all.min.js
diff --git a/docs/static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt b/docs/_static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt
rename to docs/_static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt
diff --git a/docs/static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.ttf b/docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.ttf
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.ttf
rename to docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.ttf
diff --git a/docs/static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2 b/docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2
rename to docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2
diff --git a/docs/static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.ttf b/docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.ttf
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.ttf
rename to docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.ttf
diff --git a/docs/static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2 b/docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2
rename to docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2
diff --git a/docs/static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.ttf b/docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.ttf
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.ttf
rename to docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.ttf
diff --git a/docs/static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2 b/docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2
rename to docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2
diff --git a/docs/static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.ttf b/docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.ttf
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.ttf
rename to docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.ttf
diff --git a/docs/static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2 b/docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2
similarity index 100%
rename from docs/static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2
rename to docs/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2
diff --git a/docs/static/webpack-macros.html b/docs/_static/webpack-macros.html
similarity index 100%
rename from docs/static/webpack-macros.html
rename to docs/_static/webpack-macros.html
diff --git a/docs/api/thevenin/index.html b/docs/api/thevenin/index.html
index 3c2be5c..b049913 100644
--- a/docs/api/thevenin/index.html
+++ b/docs/api/thevenin/index.html
@@ -339,9 +339,8 @@
 

How to use the documentation

Documentation is accessible via Python’s help() function which prints docstrings from a package, module, function, class, etc. In addition, you can -access the documentation by calling the built-in thevenin.docs() method to -open a local website. The website includes search functionality and examples, -beyond the code docstrings.

+access the documentation by visiting the website, hosted through GitHub pages. +The website includes search functionality and examples, beyond the docstrings.

Viewing documentation using IPython

Start IPython and import thevenin. To see what’s available in thevenin, type thevenin.<TAB> (where <TAB> is the TAB key). To view type hints diff --git a/docs/examples/example1.html b/docs/examples/example1.html index 928ec15..5371c38 100644 --- a/docs/examples/example1.html +++ b/docs/examples/example1.html @@ -428,7 +428,7 @@

1.4. Run the experiment
DLL load failed while importing ddaspk: The specified module could not be found.
 DLL load failed while importing lsodi: The specified module could not be found.
-Solve time: 0.079 s
+Solve time: 0.108 s
 
../_images/68d9a02cab54eb90e58547a4140a9f76f152e0903ed91e8df5a28672ecfb07a4.png diff --git a/docs/examples/example2.html b/docs/examples/example2.html index 00c1f78..380312b 100644 --- a/docs/examples/example2.html +++ b/docs/examples/example2.html @@ -499,7 +499,7 @@

2.5. Run the experiment
DLL load failed while importing ddaspk: The specified module could not be found.
 DLL load failed while importing lsodi: The specified module could not be found.
-Solve time: 0.092 s
+Solve time: 0.104 s
 
../_images/edf187d31bd63477763f0f585dfacda29c2020db04133979a846e23b776cd42f.png diff --git a/docs/searchindex.js b/docs/searchindex.js index 191e2ca..2d4793e 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Reference": [[0, "api-reference"]], "Build an experiment": [[2, "build-an-experiment"], [3, "build-an-experiment"]], "Classes": [[1, "classes"]], "Construct a model": [[2, "construct-a-model"], [3, "construct-a-model"]], "Define the parameters": [[3, "define-the-parameters"]], "Dictionary inputs": [[3, "dictionary-inputs"]], "Examples": [[4, "examples"]], "Import modules": [[2, "import-modules"], [3, "import-modules"]], "Package Contents": [[1, "package-contents"]], "Run the experiment": [[2, "run-the-experiment"], [3, "run-the-experiment"]], "Summary": [[5, "summary"]], "YAML file inputs": [[2, "yaml-file-inputs"]], "thevenin": [[1, "module-thevenin"]]}, "docnames": ["api/index", "api/thevenin/index", "examples/example1", "examples/example2", "examples/index", "index"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api/index.rst", "api/thevenin/index.rst", "examples/example1.ipynb", "examples/example2.ipynb", "examples/index.rst", "index.rst"], "indexentries": {"add_step() (thevenin.experiment method)": [[1, "thevenin.Experiment.add_step", false]], "cyclesolution (class in thevenin)": [[1, "thevenin.CycleSolution", false]], "errors (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.errors", false]], "errors (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.errors", false]], "experiment (class in thevenin)": [[1, "thevenin.Experiment", false]], "get_steps() (thevenin.cyclesolution method)": [[1, "thevenin.CycleSolution.get_steps", false]], "idasolver (class in thevenin)": [[1, "thevenin.IDASolver", false]], "init_step() (thevenin.idasolver method)": [[1, "thevenin.IDASolver.init_step", false]], "message (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.message", false]], "message (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.message", false]], "model (class in thevenin)": [[1, "thevenin.Model", false]], "module": [[1, "module-thevenin", false]], "num_steps (thevenin.experiment property)": [[1, "thevenin.Experiment.num_steps", false]], "plot() (thevenin.cyclesolution method)": [[1, "thevenin.CycleSolution.plot", false]], "plot() (thevenin.stepsolution method)": [[1, "thevenin.StepSolution.plot", false]], "pre() (thevenin.model method)": [[1, "thevenin.Model.pre", false]], "print_steps() (thevenin.experiment method)": [[1, "thevenin.Experiment.print_steps", false]], "residuals() (thevenin.model method)": [[1, "thevenin.Model.residuals", false]], "rhs_funcs() (thevenin.model method)": [[1, "thevenin.Model.rhs_funcs", false]], "roots (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.roots", false]], "roots (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.roots", false]], "run() (thevenin.model method)": [[1, "thevenin.Model.run", false]], "run_step() (thevenin.model method)": [[1, "thevenin.Model.run_step", false]], "solve() (thevenin.idasolver method)": [[1, "thevenin.IDASolver.solve", false]], "solvetime (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.solvetime", false]], "solvetime (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.solvetime", false]], "step() (thevenin.idasolver method)": [[1, "thevenin.IDASolver.step", false]], "steps (thevenin.experiment property)": [[1, "thevenin.Experiment.steps", false]], "stepsolution (class in thevenin)": [[1, "thevenin.StepSolution", false]], "success (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.success", false]], "success (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.success", false]], "t (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.t", false]], "t (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.t", false]], "thevenin": [[1, "module-thevenin", false]], "tstop (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.tstop", false]], "tstop (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.tstop", false]], "y (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.y", false]], "y (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.y", false]], "ydot (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.ydot", false]], "ydot (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.ydot", false]]}, "objects": {"": [[1, 0, 0, "-", "thevenin"]], "thevenin": [[1, 1, 1, "", "CycleSolution"], [1, 1, 1, "", "Experiment"], [1, 1, 1, "", "IDASolver"], [1, 1, 1, "", "Model"], [1, 1, 1, "", "StepSolution"]], "thevenin.CycleSolution": [[1, 2, 1, "", "errors"], [1, 3, 1, "", "get_steps"], [1, 2, 1, "", "message"], [1, 3, 1, "", "plot"], [1, 2, 1, "", "roots"], [1, 2, 1, "", "solvetime"], [1, 2, 1, "", "success"], [1, 2, 1, "", "t"], [1, 2, 1, "", "tstop"], [1, 2, 1, "", "y"], [1, 2, 1, "", "ydot"]], "thevenin.Experiment": [[1, 3, 1, "", "add_step"], [1, 2, 1, "", "num_steps"], [1, 3, 1, "", "print_steps"], [1, 2, 1, "", "steps"]], "thevenin.IDASolver": [[1, 3, 1, "", "init_step"], [1, 3, 1, "", "solve"], [1, 3, 1, "", "step"]], "thevenin.Model": [[1, 3, 1, "", "pre"], [1, 3, 1, "", "residuals"], [1, 3, 1, "", "rhs_funcs"], [1, 3, 1, "", "run"], [1, 3, 1, "", "run_step"]], "thevenin.StepSolution": [[1, 2, 1, "", "errors"], [1, 2, 1, "", "message"], [1, 3, 1, "", "plot"], [1, 2, 1, "", "roots"], [1, 2, 1, "", "solvetime"], [1, 2, 1, "", "success"], [1, 2, 1, "", "t"], [1, 2, 1, "", "tstop"], [1, 2, 1, "", "y"], [1, 2, 1, "", "ydot"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "property", "Python property"], "3": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:property", "3": "py:method"}, "terms": {"": [1, 2, 3], "0": [1, 2, 3, 5], "0117": 3, "0175": 3, "04": 1, "0440": 3, "0529": 3, "0571": 3, "079": 2, "07e12": 3, "0854": 3, "0875": 3, "092": 3, "1": [0, 1, 2, 3, 5], "10": [2, 3], "104300038221": 3, "1088": 3, "10e": 2, "11": 3, "12": [2, 3], "120": 2, "123": 3, "15": 3, "15988": 3, "16": 3, "1846": 3, "1895": 3, "19": 3, "19274": 3, "1958": 3, "1978": 3, "1c": 2, "1d": 1, "1e": [1, 2], "1e3": 1, "1e4": [1, 2], "1e5": 2, "2": [1, 2, 3], "200": [1, 2], "22550": 3, "23": 3, "24": 3, "2432152617": 3, "256": 3, "27": 3, "273": 3, "275": 2, "296": 3, "2d": 1, "3": [2, 3], "300": [2, 3], "305": 3, "348": 2, "35": 3, "3547435787": 3, "36": 3, "3600": [2, 3], "3e7": [1, 2], "4": [1, 2, 3], "47": 3, "5": [1, 2, 3], "500": 1, "5309": 3, "534": 2, "5416": 3, "5692": 3, "592": 2, "5e": 3, "6": [1, 2, 3], "60": 3, "600": [2, 3], "62": 3, "631463739": 3, "6343726509044": 3, "6379": 3, "63809042502323": 3, "67": 3, "6875": 3, "7": [2, 3], "7038": 3, "745": [2, 3], "74760241881": 3, "75": [2, 3], "8": [2, 3], "80": 2, "82880284425": 3, "84": 2, "84e": 3, "8818738468": 3, "89133579961": 3, "8e": 3, "9": [2, 3], "9142": 3, "96": 3, "A": [1, 2, 3, 5], "As": 1, "Be": 2, "For": [1, 2], "If": [1, 2, 3], "In": [1, 2, 3], "It": [1, 3], "Not": 1, "The": [1, 2, 3, 5], "These": 1, "To": [1, 2, 3], "a_therm": [1, 2, 3], "about": [2, 3], "absolut": [1, 2], "access": [1, 2], "ad": [2, 3], "add": 1, "add_step": [1, 2, 3], "addit": [1, 3], "adjust": [1, 2, 3], "after": [1, 2, 3], "afterward": [1, 2, 3], "again": 1, "against": [1, 2, 3], "ah": [1, 3], "ai": 3, "air": 1, "algebra": [1, 3], "algidx": 1, "all": [1, 2, 3, 5], "alloc": 1, "allow": [1, 2, 3], "also": [1, 2, 3], "alter": 1, "altern": 2, "although": 2, "alwai": [1, 2, 3], "amount": 1, "an": [1, 5], "anaconda": 5, "analysi": [2, 3], "ani": [1, 2, 3, 5], "anoth": [2, 3], "api": [1, 5], "appear": 1, "append": 2, "applic": [2, 3], "appropri": 1, "ar": [1, 2, 3], "arang": [1, 2, 3], "area": 1, "argument": [1, 2, 3], "aris": 1, "around": 2, "arrai": [1, 2, 3], "associ": 2, "assum": 3, "atol": 1, "attribut": [1, 2, 3], "auto": 0, "autoapi": 0, "automat": [1, 2, 3], "autonom": 3, "avail": 1, "axi": 1, "b": 3, "back": [2, 3], "band": 1, "bandwidth": 1, "basi": [2, 3], "basic": [2, 4], "batt": 3, "batteri": [1, 2, 3, 5], "been": [2, 3], "befor": [1, 2, 3], "below": [1, 2, 3], "besid": 1, "between": [1, 2, 3], "beyond": 1, "bool": 1, "both": [1, 3], "boundari": 1, "brief": 1, "build": [1, 5], "builder": 1, "built": [1, 2, 3], "c": 3, "c1": [1, 2, 3], "c1_func": 3, "c2": [1, 2], "c3": 2, "calc_ua": 3, "calc_xa": 3, "call": [1, 2, 3], "callabl": [1, 2], "can": [1, 2, 3], "capabl": 3, "capac": [1, 2, 3], "capacit": 1, "capacitor": [1, 2, 3, 5], "capacity_ah": 1, "case": [1, 2, 3], "caus": 1, "cell": 2, "center": 2, "challeng": 3, "chang": 1, "charg": [1, 2, 3], "circuit": [1, 2, 3, 5], "cj": [1, 2], "class": [2, 3, 5], "code": 1, "coeff": 3, "coeffici": 1, "colon": 2, "column": 1, "come": 3, "common": [1, 5], "complex": [1, 3], "condit": [1, 3], "confus": 2, "consequ": 1, "consist": [1, 2, 5], "constant": [1, 2, 3], "constraint": 1, "construct": 1, "constructor": 2, "contain": [0, 1, 2, 3, 5], "contion": 1, "control": [1, 2, 3], "convect": 1, "conveni": 2, "correct": [1, 2, 3], "correspond": 1, "could": [2, 3], "cp": [1, 2, 3], "creat": 0, "criteria": [1, 2, 3], "current": [2, 3], "current_a": [1, 2, 3], "custom": 2, "cycl": [1, 2], "cycle_soln": 2, "cyclesolut": [1, 2], "cylcesolut": 2, "d": 2, "dae": 1, "ddaspk": [2, 3], "def": [1, 3], "default": [1, 2], "defin": [1, 2], "demonstr": [1, 3], "dens": 1, "depend": 1, "deriv": 1, "descript": [1, 2, 3], "detail": [1, 5], "detect": 1, "determin": [1, 2, 3], "dict": [1, 3], "dictionari": [1, 2, 4], "did": 1, "differ": [2, 3], "differenti": 1, "discharg": [2, 3], "dll": [2, 3], "do": 2, "doc": [1, 5], "docstr": 1, "document": [0, 1, 2, 5], "documnet": [2, 3], "doe": [1, 2], "done": 3, "dt": [1, 2, 3], "dure": [1, 3], "duti": 2, "dynam": [2, 3], "e": [1, 2, 3, 5], "each": [1, 2, 3], "earli": [1, 2, 3], "either": [1, 2, 3], "element": [2, 3], "empti": [2, 3], "end": [1, 2, 3], "ensur": 2, "equal": 1, "equat": 1, "equival": [1, 2, 3, 5], "error": 1, "etc": [1, 2, 3, 5], "eval": 2, "even": [1, 2], "event": 1, "exampl": [1, 2, 3, 5], "excess": 1, "exercis": 2, "exit": 1, "exp": [1, 2, 3], "expand": 5, "experi": [1, 5], "experiment": 1, "express": [1, 2, 3], "extent": 2, "f": [1, 2, 3], "fail": [2, 3], "fals": [1, 2, 3], "fidel": [1, 5], "figur": [2, 3], "file": [1, 3, 4], "fill": 1, "final": 3, "fine": 1, "finsh": 2, "first": [1, 2, 3], "fit": 3, "flag": 1, "float": [1, 2, 3], "follow": [1, 2, 3], "forget": 1, "format": [1, 2, 3], "found": [2, 3], "from": [1, 3], "fullest": 2, "function": [1, 2, 3, 5], "g": [1, 2], "gener": [0, 1, 2, 3], "get": [2, 4, 5], "get_step": [1, 2], "give": 1, "given": [1, 2, 3], "go": [2, 5], "govern": 1, "graphit": 3, "great": 5, "h_therm": [1, 2, 3], "ha": [1, 2], "hand": 1, "handl": [2, 3], "have": [1, 2, 3], "heat": 1, "help": [1, 2, 3], "here": 1, "high": 2, "higher": 1, "hint": 1, "hit": [2, 3], "hold": [2, 3], "hour": [2, 3], "how": [1, 2, 3, 5], "howev": [1, 2], "hppc": 3, "hstack": 1, "i": [1, 2, 3, 5], "ida": 1, "idasol": 1, "idasolv": 1, "identifi": 3, "idx": 1, "implicit": 1, "import": 1, "includ": [1, 2, 3], "inclus": 2, "inconsist": 1, "index": [1, 2], "indic": 1, "inform": 1, "init_step": 1, "initcond": 1, "initi": [1, 2, 3], "input": [1, 4], "instabl": 1, "instanc": [1, 2, 3], "instanti": 1, "instead": [1, 2, 3], "int": [1, 2, 3], "integ": [1, 2, 3], "integr": 1, "interest": [2, 3], "interfac": 2, "intern": [1, 2, 3], "interpret": [1, 2], "interpretor": 2, "invalid": 1, "ipython": 1, "isotherm": [1, 2, 3], "its": [1, 2, 3], "j": 1, "just": 1, "k": [1, 2, 3], "kei": [1, 2, 3], "keyword": [1, 2, 3], "kg": 1, "know": [1, 2, 3], "kokam": 3, "kwarg": 1, "lambda": 2, "last": 1, "lband": 1, "learn": [2, 3, 4, 5], "length": 1, "let": 1, "like": [1, 2, 3], "limit": [1, 2, 3], "linear": 1, "link": 5, "linsolv": 1, "linspac": [1, 2, 3], "list": [1, 2, 3], "load": [1, 2, 3], "local": [1, 2], "logspac": 1, "long": 1, "look": 2, "loss": 1, "low": [1, 2, 5], "lower": 1, "lsodi": [2, 3], "m": 1, "m2": 1, "made": 3, "mai": 1, "main": 2, "manipul": 2, "manual": [1, 2], "map": [1, 3], "mass": [1, 2, 3], "math": 2, "matlab": 1, "matplotlib": [1, 5], "matrix": 1, "max_dt": [1, 2], "maximum": 1, "memori": 1, "messag": 1, "method": [1, 2, 3], "might": 1, "min": [2, 3], "minim": 1, "mode": [1, 2, 3], "model": [1, 5], "modifi": 1, "modul": [1, 5], "more": [1, 2, 3], "most": 1, "multipl": 3, "must": [1, 2, 3], "n": 2, "name": [1, 2], "nativ": 2, "ndarrai": 1, "necessari": 3, "need": 1, "new": [1, 2, 3], "next": [1, 2, 3], "nmc": 3, "nomin": [2, 3], "none": 1, "normalize_input": 3, "note": [1, 2, 3], "np": [1, 2, 3], "nr_rootfn": 1, "nt": [1, 2, 3], "num_rc_pair": [1, 2, 3], "num_step": [1, 2], "number": [1, 2, 5], "numpi": [1, 2, 3, 5], "ocv": [1, 2, 3], "ocv_func": 3, "od": [1, 5], "ohm": [1, 2], "onc": 2, "one": [1, 2, 3], "onli": [1, 2, 3], "open": [1, 2, 3], "option": [1, 2, 3], "order": [1, 2, 3], "organ": 1, "origin": [2, 3], "other": [1, 2], "otherwis": 1, "out": [1, 2, 3], "output": [2, 3], "over": 1, "overal": 1, "own": 2, "packag": [2, 5], "page": 0, "pair": [1, 2, 5], "parallel": [1, 5], "param": [1, 2, 3], "paramet": [1, 2], "parenthesi": 1, "pass": 1, "path": [1, 2], "per": [2, 3], "perform": [1, 2, 3], "pi": 2, "pipe": 2, "place": 5, "plot": [1, 2, 3], "plt": 1, "pointer": 1, "polyv": 3, "posit": [2, 3], "possibl": 2, "power": [2, 3], "power_w": [1, 2], "pre": [1, 2, 3], "prefer": [2, 3], "prepar": 1, "preprocessor": 1, "previou": [1, 3], "print": [1, 2, 3], "print_step": 1, "prior": 1, "problem": 1, "process": [1, 2, 3], "processor": [1, 2], "produc": 1, "profil": [1, 2, 3], "progress": 1, "properti": 1, "protocol": [1, 2], "provid": [1, 2], "pull": 2, "puls": 3, "purpos": 1, "pyplot": 1, "python": [1, 2, 5], "q_di": 3, "quickli": [2, 3], "r0": [1, 2, 3], "r0_func": 3, "r1": [1, 2, 3], "r1_func": 3, "r2": [1, 2], "r3": 2, "rais": 1, "rang": [1, 2], "rate": [2, 3], "rc": [1, 2, 5], "rcj": 1, "re": [1, 2], "reach": [2, 3], "read": 2, "readabl": 1, "readalb": 1, "record": 1, "refer": 5, "regard": 1, "regardless": [2, 3], "regist": 1, "rel": [1, 2, 3], "relat": 1, "remain": 2, "renam": 2, "repres": [1, 2], "request": 1, "requir": [1, 2, 3], "reset": 1, "residu": 1, "resist": 1, "resistor": [1, 2, 3, 5], "resitor": [2, 5], "respect": [1, 2], "rest": [2, 3], "result": 1, "return": [1, 2, 3], "rh": 1, "rhs_func": 1, "right": 1, "rj": [1, 2], "room": 1, "root": 1, "rootfn": 1, "row": 1, "rtol": 1, "run": [1, 5], "run_step": [1, 2, 3], "same": [1, 2], "save": [1, 2, 3], "scale": 1, "scikit": [1, 5], "search": 1, "second": [1, 2, 3], "see": [1, 2, 3, 5], "self": [2, 3], "semi": 3, "semilogx": 1, "sequenti": [1, 2], "seri": [1, 2, 3, 5], "set": [1, 2, 3], "share": 1, "should": [1, 2, 3], "show": 1, "shown": [2, 3], "side": 1, "signatur": 1, "significantli": 1, "similar": 2, "simpli": 2, "sin": 2, "sinatur": [2, 3], "sinc": 2, "singl": [1, 2, 3, 5], "sinusoid": 2, "size": 1, "skill": 5, "so": 2, "soc": [1, 2, 3], "soc0": [1, 2, 3], "softwar": 3, "sol": [1, 2, 3], "solut": [1, 2, 3], "solv": [1, 2, 3], "solver": [1, 2, 3], "solverreturn": 1, "solvetim": [1, 2, 3], "some": [3, 5], "some_step": 2, "sourc": [1, 3], "span": [1, 2, 3], "special": 1, "specif": 1, "specifi": [1, 2, 3], "spefi": [2, 3], "spent": 1, "sphinx": 0, "spyder": 5, "stand": 1, "start": [1, 2, 3, 4], "state": [1, 2, 3], "statement": 1, "statu": 1, "step": [1, 2, 3], "stepidx": 1, "stepsolut": [1, 2], "stitch": [1, 2], "stop": 1, "store": 1, "str": 1, "stressor": 3, "string": 1, "subpacakg": 1, "subsequ": 1, "subset": [1, 2], "success": 1, "sundial": 1, "support": [1, 2], "sure": 2, "sv": 1, "svdot": 1, "system": 1, "t": [1, 2, 3], "t0": 1, "t_cell": [1, 2, 3], "t_inf": [1, 2, 3], "t_max": [1, 2, 3], "t_norm": 3, "tab": 1, "take": 2, "tanh": 3, "tell": 1, "tempeartur": 2, "temperatur": [1, 3], "temperature_k": 1, "templat": [1, 2], "term": 1, "test": [2, 3], "than": 1, "thei": 1, "them": 2, "therefor": [1, 2, 3], "thevenin": [0, 2, 3, 5], "thi": [0, 1, 2, 3, 5], "though": 1, "three": 2, "through": [1, 2], "time": [1, 2, 3], "time_": 1, "time_h": [1, 2, 3], "time_min": 1, "timer": 1, "togeth": [1, 2], "toler": 1, "took": 1, "total": 1, "track": 1, "trigger": [1, 2, 3], "true": 1, "try": 1, "tspan": [1, 2, 3], "tstop": 1, "tune": 1, "tupl": 1, "tutori": 4, "two": [1, 2, 3], "type": 1, "typeerror": 1, "ua": 3, "ua_norm": 3, "uband": 1, "uncertain": 1, "understand": 2, "unformat": 1, "unit": [1, 2, 3], "unless": 1, "unpack": 1, "unrestrict": 1, "until": [1, 2, 3], "up": [2, 3], "updat": 1, "upper": 1, "us": [1, 2, 3, 5], "user": [1, 2], "userwarn": 2, "v": [1, 2, 3], "valu": [1, 2, 3], "valueerror": 1, "var": [1, 2, 3], "variabl": [1, 2, 3], "veri": 2, "version": 5, "via": 1, "view": 1, "visual": 1, "voltag": [1, 2, 3], "voltage_v": [1, 2, 3], "w": [1, 2], "wa": [1, 3], "walk": 2, "want": [1, 2, 3], "warn": 2, "we": 1, "websit": 1, "were": [1, 3], "what": 1, "when": [1, 2, 3], "where": [1, 2, 3], "whether": 1, "which": [1, 2, 3], "while": [2, 3], "within": 1, "word": 1, "would": [2, 3], "wrapper": 1, "write": [1, 2], "written": 1, "x": [1, 2, 3], "xa": 3, "y": [1, 2, 3], "y0": 1, "yaml": [1, 3, 4], "ydot": 1, "ydot0": 1, "you": [1, 2, 3], "your": [2, 3, 5], "yp": 1, "yp0": 1, "zero": 1, "zeros_lik": 1}, "titles": ["API Reference", "thevenin", "1. YAML file inputs", "2. Dictionary inputs", "Examples", "Summary"], "titleterms": {"an": [2, 3], "api": 0, "build": [2, 3], "class": 1, "construct": [2, 3], "content": 1, "defin": 3, "dictionari": 3, "exampl": 4, "experi": [2, 3], "file": 2, "import": [2, 3], "input": [2, 3], "model": [2, 3], "modul": [2, 3], "packag": 1, "paramet": 3, "refer": 0, "run": [2, 3], "summari": 5, "thevenin": 1, "yaml": 2}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Reference": [[0, "api-reference"]], "Build an experiment": [[2, "build-an-experiment"], [3, "build-an-experiment"]], "Classes": [[1, "classes"]], "Construct a model": [[2, "construct-a-model"], [3, "construct-a-model"]], "Define the parameters": [[3, "define-the-parameters"]], "Dictionary inputs": [[3, "dictionary-inputs"]], "Examples": [[4, "examples"]], "Import modules": [[2, "import-modules"], [3, "import-modules"]], "Package Contents": [[1, "package-contents"]], "Run the experiment": [[2, "run-the-experiment"], [3, "run-the-experiment"]], "Summary": [[5, "summary"]], "YAML file inputs": [[2, "yaml-file-inputs"]], "thevenin": [[1, "module-thevenin"]]}, "docnames": ["api/index", "api/thevenin/index", "examples/example1", "examples/example2", "examples/index", "index"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api/index.rst", "api/thevenin/index.rst", "examples/example1.ipynb", "examples/example2.ipynb", "examples/index.rst", "index.rst"], "indexentries": {"add_step() (thevenin.experiment method)": [[1, "thevenin.Experiment.add_step", false]], "cyclesolution (class in thevenin)": [[1, "thevenin.CycleSolution", false]], "errors (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.errors", false]], "errors (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.errors", false]], "experiment (class in thevenin)": [[1, "thevenin.Experiment", false]], "get_steps() (thevenin.cyclesolution method)": [[1, "thevenin.CycleSolution.get_steps", false]], "idasolver (class in thevenin)": [[1, "thevenin.IDASolver", false]], "init_step() (thevenin.idasolver method)": [[1, "thevenin.IDASolver.init_step", false]], "message (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.message", false]], "message (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.message", false]], "model (class in thevenin)": [[1, "thevenin.Model", false]], "module": [[1, "module-thevenin", false]], "num_steps (thevenin.experiment property)": [[1, "thevenin.Experiment.num_steps", false]], "plot() (thevenin.cyclesolution method)": [[1, "thevenin.CycleSolution.plot", false]], "plot() (thevenin.stepsolution method)": [[1, "thevenin.StepSolution.plot", false]], "pre() (thevenin.model method)": [[1, "thevenin.Model.pre", false]], "print_steps() (thevenin.experiment method)": [[1, "thevenin.Experiment.print_steps", false]], "residuals() (thevenin.model method)": [[1, "thevenin.Model.residuals", false]], "rhs_funcs() (thevenin.model method)": [[1, "thevenin.Model.rhs_funcs", false]], "roots (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.roots", false]], "roots (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.roots", false]], "run() (thevenin.model method)": [[1, "thevenin.Model.run", false]], "run_step() (thevenin.model method)": [[1, "thevenin.Model.run_step", false]], "solve() (thevenin.idasolver method)": [[1, "thevenin.IDASolver.solve", false]], "solvetime (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.solvetime", false]], "solvetime (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.solvetime", false]], "step() (thevenin.idasolver method)": [[1, "thevenin.IDASolver.step", false]], "steps (thevenin.experiment property)": [[1, "thevenin.Experiment.steps", false]], "stepsolution (class in thevenin)": [[1, "thevenin.StepSolution", false]], "success (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.success", false]], "success (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.success", false]], "t (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.t", false]], "t (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.t", false]], "thevenin": [[1, "module-thevenin", false]], "tstop (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.tstop", false]], "tstop (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.tstop", false]], "y (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.y", false]], "y (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.y", false]], "ydot (thevenin.cyclesolution property)": [[1, "thevenin.CycleSolution.ydot", false]], "ydot (thevenin.stepsolution property)": [[1, "thevenin.StepSolution.ydot", false]]}, "objects": {"": [[1, 0, 0, "-", "thevenin"]], "thevenin": [[1, 1, 1, "", "CycleSolution"], [1, 1, 1, "", "Experiment"], [1, 1, 1, "", "IDASolver"], [1, 1, 1, "", "Model"], [1, 1, 1, "", "StepSolution"]], "thevenin.CycleSolution": [[1, 2, 1, "", "errors"], [1, 3, 1, "", "get_steps"], [1, 2, 1, "", "message"], [1, 3, 1, "", "plot"], [1, 2, 1, "", "roots"], [1, 2, 1, "", "solvetime"], [1, 2, 1, "", "success"], [1, 2, 1, "", "t"], [1, 2, 1, "", "tstop"], [1, 2, 1, "", "y"], [1, 2, 1, "", "ydot"]], "thevenin.Experiment": [[1, 3, 1, "", "add_step"], [1, 2, 1, "", "num_steps"], [1, 3, 1, "", "print_steps"], [1, 2, 1, "", "steps"]], "thevenin.IDASolver": [[1, 3, 1, "", "init_step"], [1, 3, 1, "", "solve"], [1, 3, 1, "", "step"]], "thevenin.Model": [[1, 3, 1, "", "pre"], [1, 3, 1, "", "residuals"], [1, 3, 1, "", "rhs_funcs"], [1, 3, 1, "", "run"], [1, 3, 1, "", "run_step"]], "thevenin.StepSolution": [[1, 2, 1, "", "errors"], [1, 2, 1, "", "message"], [1, 3, 1, "", "plot"], [1, 2, 1, "", "roots"], [1, 2, 1, "", "solvetime"], [1, 2, 1, "", "success"], [1, 2, 1, "", "t"], [1, 2, 1, "", "tstop"], [1, 2, 1, "", "y"], [1, 2, 1, "", "ydot"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "property", "Python property"], "3": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:property", "3": "py:method"}, "terms": {"": [1, 2, 3], "0": [1, 2, 3, 5], "0117": 3, "0175": 3, "04": 1, "0440": 3, "0529": 3, "0571": 3, "07e12": 3, "0854": 3, "0875": 3, "1": [0, 1, 2, 3, 5], "10": [2, 3], "104": 3, "104300038221": 3, "108": 2, "1088": 3, "10e": 2, "11": 3, "12": [2, 3], "120": 2, "123": 3, "15": 3, "15988": 3, "16": 3, "1846": 3, "1895": 3, "19": 3, "19274": 3, "1958": 3, "1978": 3, "1c": 2, "1d": 1, "1e": [1, 2], "1e3": 1, "1e4": [1, 2], "1e5": 2, "2": [1, 2, 3], "200": [1, 2], "22550": 3, "23": 3, "24": 3, "2432152617": 3, "256": 3, "27": 3, "273": 3, "275": 2, "296": 3, "2d": 1, "3": [2, 3], "300": [2, 3], "305": 3, "348": 2, "35": 3, "3547435787": 3, "36": 3, "3600": [2, 3], "3e7": [1, 2], "4": [1, 2, 3], "47": 3, "5": [1, 2, 3], "500": 1, "5309": 3, "534": 2, "5416": 3, "5692": 3, "592": 2, "5e": 3, "6": [1, 2, 3], "60": 3, "600": [2, 3], "62": 3, "631463739": 3, "6343726509044": 3, "6379": 3, "63809042502323": 3, "67": 3, "6875": 3, "7": [2, 3], "7038": 3, "745": [2, 3], "74760241881": 3, "75": [2, 3], "8": [2, 3], "80": 2, "82880284425": 3, "84": 2, "84e": 3, "8818738468": 3, "89133579961": 3, "8e": 3, "9": [2, 3], "9142": 3, "96": 3, "A": [1, 2, 3, 5], "As": 1, "Be": 2, "For": [1, 2], "If": [1, 2, 3], "In": [1, 2, 3], "It": [1, 3], "Not": 1, "The": [1, 2, 3, 5], "These": 1, "To": [1, 2, 3], "a_therm": [1, 2, 3], "about": [2, 3], "absolut": [1, 2], "access": [1, 2], "ad": [2, 3], "add": 1, "add_step": [1, 2, 3], "addit": [1, 3], "adjust": [1, 2, 3], "after": [1, 2, 3], "afterward": [1, 2, 3], "again": 1, "against": [1, 2, 3], "ah": [1, 3], "ai": 3, "air": 1, "algebra": [1, 3], "algidx": 1, "all": [1, 2, 3, 5], "alloc": 1, "allow": [1, 2, 3], "also": [1, 2, 3], "alter": 1, "altern": 2, "although": 2, "alwai": [1, 2, 3], "amount": 1, "an": [1, 5], "anaconda": 5, "analysi": [2, 3], "ani": [1, 2, 3, 5], "anoth": [2, 3], "api": [1, 5], "appear": 1, "append": 2, "applic": [2, 3], "appropri": 1, "ar": [1, 2, 3], "arang": [1, 2, 3], "area": 1, "argument": [1, 2, 3], "aris": 1, "around": 2, "arrai": [1, 2, 3], "associ": 2, "assum": 3, "atol": 1, "attribut": [1, 2, 3], "auto": 0, "autoapi": 0, "automat": [1, 2, 3], "autonom": 3, "avail": 1, "axi": 1, "b": 3, "back": [2, 3], "band": 1, "bandwidth": 1, "basi": [2, 3], "basic": [2, 4], "batt": 3, "batteri": [1, 2, 3, 5], "been": [2, 3], "befor": [1, 2, 3], "below": [1, 2, 3], "besid": 1, "between": [1, 2, 3], "beyond": 1, "bool": 1, "both": [1, 3], "boundari": 1, "brief": 1, "build": [1, 5], "builder": 1, "built": [2, 3], "c": 3, "c1": [1, 2, 3], "c1_func": 3, "c2": [1, 2], "c3": 2, "calc_ua": 3, "calc_xa": 3, "call": [1, 2, 3], "callabl": [1, 2], "can": [1, 2, 3], "capabl": 3, "capac": [1, 2, 3], "capacit": 1, "capacitor": [1, 2, 3, 5], "capacity_ah": 1, "case": [1, 2, 3], "caus": 1, "cell": 2, "center": 2, "challeng": 3, "chang": 1, "charg": [1, 2, 3], "circuit": [1, 2, 3, 5], "cj": [1, 2], "class": [2, 3, 5], "coeff": 3, "coeffici": 1, "colon": 2, "column": 1, "come": 3, "common": [1, 5], "complex": [1, 3], "condit": [1, 3], "confus": 2, "consequ": 1, "consist": [1, 2, 5], "constant": [1, 2, 3], "constraint": 1, "construct": 1, "constructor": 2, "contain": [0, 1, 2, 3, 5], "contion": 1, "control": [1, 2, 3], "convect": 1, "conveni": 2, "correct": [1, 2, 3], "correspond": 1, "could": [2, 3], "cp": [1, 2, 3], "creat": 0, "criteria": [1, 2, 3], "current": [2, 3], "current_a": [1, 2, 3], "custom": 2, "cycl": [1, 2], "cycle_soln": 2, "cyclesolut": [1, 2], "cylcesolut": 2, "d": 2, "dae": 1, "ddaspk": [2, 3], "def": [1, 3], "default": [1, 2], "defin": [1, 2], "demonstr": [1, 3], "dens": 1, "depend": 1, "deriv": 1, "descript": [1, 2, 3], "detail": [1, 5], "detect": 1, "determin": [1, 2, 3], "dict": [1, 3], "dictionari": [1, 2, 4], "did": 1, "differ": [2, 3], "differenti": 1, "discharg": [2, 3], "dll": [2, 3], "do": 2, "doc": 5, "docstr": 1, "document": [0, 1, 2, 5], "documnet": [2, 3], "doe": [1, 2], "done": 3, "dt": [1, 2, 3], "dure": [1, 3], "duti": 2, "dynam": [2, 3], "e": [1, 2, 3, 5], "each": [1, 2, 3], "earli": [1, 2, 3], "either": [1, 2, 3], "element": [2, 3], "empti": [2, 3], "end": [1, 2, 3], "ensur": 2, "equal": 1, "equat": 1, "equival": [1, 2, 3, 5], "error": 1, "etc": [1, 2, 3, 5], "eval": 2, "even": [1, 2], "event": 1, "exampl": [1, 2, 3, 5], "excess": 1, "exercis": 2, "exit": 1, "exp": [1, 2, 3], "expand": 5, "experi": [1, 5], "experiment": 1, "express": [1, 2, 3], "extent": 2, "f": [1, 2, 3], "fail": [2, 3], "fals": [1, 2, 3], "fidel": [1, 5], "figur": [2, 3], "file": [1, 3, 4], "fill": 1, "final": 3, "fine": 1, "finsh": 2, "first": [1, 2, 3], "fit": 3, "flag": 1, "float": [1, 2, 3], "follow": [1, 2, 3], "forget": 1, "format": [1, 2, 3], "found": [2, 3], "from": [1, 3], "fullest": 2, "function": [1, 2, 3, 5], "g": [1, 2], "gener": [0, 1, 2, 3], "get": [2, 4, 5], "get_step": [1, 2], "github": 1, "give": 1, "given": [1, 2, 3], "go": [2, 5], "govern": 1, "graphit": 3, "great": 5, "h_therm": [1, 2, 3], "ha": [1, 2], "hand": 1, "handl": [2, 3], "have": [1, 2, 3], "heat": 1, "help": [1, 2, 3], "here": 1, "high": 2, "higher": 1, "hint": 1, "hit": [2, 3], "hold": [2, 3], "host": 1, "hour": [2, 3], "how": [1, 2, 3, 5], "howev": [1, 2], "hppc": 3, "hstack": 1, "i": [1, 2, 3, 5], "ida": 1, "idasol": 1, "idasolv": 1, "identifi": 3, "idx": 1, "implicit": 1, "import": 1, "includ": [1, 2, 3], "inclus": 2, "inconsist": 1, "index": [1, 2], "indic": 1, "inform": 1, "init_step": 1, "initcond": 1, "initi": [1, 2, 3], "input": [1, 4], "instabl": 1, "instanc": [1, 2, 3], "instanti": 1, "instead": [1, 2, 3], "int": [1, 2, 3], "integ": [1, 2, 3], "integr": 1, "interest": [2, 3], "interfac": 2, "intern": [1, 2, 3], "interpret": [1, 2], "interpretor": 2, "invalid": 1, "ipython": 1, "isotherm": [1, 2, 3], "its": [1, 2, 3], "j": 1, "just": 1, "k": [1, 2, 3], "kei": [1, 2, 3], "keyword": [1, 2, 3], "kg": 1, "know": [1, 2, 3], "kokam": 3, "kwarg": 1, "lambda": 2, "last": 1, "lband": 1, "learn": [2, 3, 4, 5], "length": 1, "let": 1, "like": [1, 2, 3], "limit": [1, 2, 3], "linear": 1, "link": 5, "linsolv": 1, "linspac": [1, 2, 3], "list": [1, 2, 3], "load": [1, 2, 3], "local": 2, "logspac": 1, "long": 1, "look": 2, "loss": 1, "low": [1, 2, 5], "lower": 1, "lsodi": [2, 3], "m": 1, "m2": 1, "made": 3, "mai": 1, "main": 2, "manipul": 2, "manual": [1, 2], "map": [1, 3], "mass": [1, 2, 3], "math": 2, "matlab": 1, "matplotlib": [1, 5], "matrix": 1, "max_dt": [1, 2], "maximum": 1, "memori": 1, "messag": 1, "method": [1, 2, 3], "might": 1, "min": [2, 3], "minim": 1, "mode": [1, 2, 3], "model": [1, 5], "modifi": 1, "modul": [1, 5], "more": [1, 2, 3], "most": 1, "multipl": 3, "must": [1, 2, 3], "n": 2, "name": [1, 2], "nativ": 2, "ndarrai": 1, "necessari": 3, "need": 1, "new": [1, 2, 3], "next": [1, 2, 3], "nmc": 3, "nomin": [2, 3], "none": 1, "normalize_input": 3, "note": [1, 2, 3], "np": [1, 2, 3], "nr_rootfn": 1, "nt": [1, 2, 3], "num_rc_pair": [1, 2, 3], "num_step": [1, 2], "number": [1, 2, 5], "numpi": [1, 2, 3, 5], "ocv": [1, 2, 3], "ocv_func": 3, "od": [1, 5], "ohm": [1, 2], "onc": 2, "one": [1, 2, 3], "onli": [1, 2, 3], "open": [1, 2, 3], "option": [1, 2, 3], "order": [1, 2, 3], "organ": 1, "origin": [2, 3], "other": [1, 2], "otherwis": 1, "out": [1, 2, 3], "output": [2, 3], "over": 1, "overal": 1, "own": 2, "packag": [2, 5], "page": [0, 1], "pair": [1, 2, 5], "parallel": [1, 5], "param": [1, 2, 3], "paramet": [1, 2], "parenthesi": 1, "pass": 1, "path": [1, 2], "per": [2, 3], "perform": [1, 2, 3], "pi": 2, "pipe": 2, "place": 5, "plot": [1, 2, 3], "plt": 1, "pointer": 1, "polyv": 3, "posit": [2, 3], "possibl": 2, "power": [2, 3], "power_w": [1, 2], "pre": [1, 2, 3], "prefer": [2, 3], "prepar": 1, "preprocessor": 1, "previou": [1, 3], "print": [1, 2, 3], "print_step": 1, "prior": 1, "problem": 1, "process": [1, 2, 3], "processor": [1, 2], "produc": 1, "profil": [1, 2, 3], "progress": 1, "properti": 1, "protocol": [1, 2], "provid": [1, 2], "pull": 2, "puls": 3, "purpos": 1, "pyplot": 1, "python": [1, 2, 5], "q_di": 3, "quickli": [2, 3], "r0": [1, 2, 3], "r0_func": 3, "r1": [1, 2, 3], "r1_func": 3, "r2": [1, 2], "r3": 2, "rais": 1, "rang": [1, 2], "rate": [2, 3], "rc": [1, 2, 5], "rcj": 1, "re": [1, 2], "reach": [2, 3], "read": 2, "readabl": 1, "readalb": 1, "record": 1, "refer": 5, "regard": 1, "regardless": [2, 3], "regist": 1, "rel": [1, 2, 3], "relat": 1, "remain": 2, "renam": 2, "repres": [1, 2], "request": 1, "requir": [1, 2, 3], "reset": 1, "residu": 1, "resist": 1, "resistor": [1, 2, 3, 5], "resitor": [2, 5], "respect": [1, 2], "rest": [2, 3], "result": 1, "return": [1, 2, 3], "rh": 1, "rhs_func": 1, "right": 1, "rj": [1, 2], "room": 1, "root": 1, "rootfn": 1, "row": 1, "rtol": 1, "run": [1, 5], "run_step": [1, 2, 3], "same": [1, 2], "save": [1, 2, 3], "scale": 1, "scikit": [1, 5], "search": 1, "second": [1, 2, 3], "see": [1, 2, 3, 5], "self": [2, 3], "semi": 3, "semilogx": 1, "sequenti": [1, 2], "seri": [1, 2, 3, 5], "set": [1, 2, 3], "share": 1, "should": [1, 2, 3], "show": 1, "shown": [2, 3], "side": 1, "signatur": 1, "significantli": 1, "similar": 2, "simpli": 2, "sin": 2, "sinatur": [2, 3], "sinc": 2, "singl": [1, 2, 3, 5], "sinusoid": 2, "size": 1, "skill": 5, "so": 2, "soc": [1, 2, 3], "soc0": [1, 2, 3], "softwar": 3, "sol": [1, 2, 3], "solut": [1, 2, 3], "solv": [1, 2, 3], "solver": [1, 2, 3], "solverreturn": 1, "solvetim": [1, 2, 3], "some": [3, 5], "some_step": 2, "sourc": [1, 3], "span": [1, 2, 3], "special": 1, "specif": 1, "specifi": [1, 2, 3], "spefi": [2, 3], "spent": 1, "sphinx": 0, "spyder": 5, "stand": 1, "start": [1, 2, 3, 4], "state": [1, 2, 3], "statement": 1, "statu": 1, "step": [1, 2, 3], "stepidx": 1, "stepsolut": [1, 2], "stitch": [1, 2], "stop": 1, "store": 1, "str": 1, "stressor": 3, "string": 1, "subpacakg": 1, "subsequ": 1, "subset": [1, 2], "success": 1, "sundial": 1, "support": [1, 2], "sure": 2, "sv": 1, "svdot": 1, "system": 1, "t": [1, 2, 3], "t0": 1, "t_cell": [1, 2, 3], "t_inf": [1, 2, 3], "t_max": [1, 2, 3], "t_norm": 3, "tab": 1, "take": 2, "tanh": 3, "tell": 1, "tempeartur": 2, "temperatur": [1, 3], "temperature_k": 1, "templat": [1, 2], "term": 1, "test": [2, 3], "than": 1, "thei": 1, "them": 2, "therefor": [1, 2, 3], "thevenin": [0, 2, 3, 5], "thi": [0, 1, 2, 3, 5], "though": 1, "three": 2, "through": [1, 2], "time": [1, 2, 3], "time_": 1, "time_h": [1, 2, 3], "time_min": 1, "timer": 1, "togeth": [1, 2], "toler": 1, "took": 1, "total": 1, "track": 1, "trigger": [1, 2, 3], "true": 1, "try": 1, "tspan": [1, 2, 3], "tstop": 1, "tune": 1, "tupl": 1, "tutori": 4, "two": [1, 2, 3], "type": 1, "typeerror": 1, "ua": 3, "ua_norm": 3, "uband": 1, "uncertain": 1, "understand": 2, "unformat": 1, "unit": [1, 2, 3], "unless": 1, "unpack": 1, "unrestrict": 1, "until": [1, 2, 3], "up": [2, 3], "updat": 1, "upper": 1, "us": [1, 2, 3, 5], "user": [1, 2], "userwarn": 2, "v": [1, 2, 3], "valu": [1, 2, 3], "valueerror": 1, "var": [1, 2, 3], "variabl": [1, 2, 3], "veri": 2, "version": 5, "via": 1, "view": 1, "visit": 1, "visual": 1, "voltag": [1, 2, 3], "voltage_v": [1, 2, 3], "w": [1, 2], "wa": [1, 3], "walk": 2, "want": [1, 2, 3], "warn": 2, "we": 1, "websit": 1, "were": [1, 3], "what": 1, "when": [1, 2, 3], "where": [1, 2, 3], "whether": 1, "which": [1, 2, 3], "while": [2, 3], "within": 1, "word": 1, "would": [2, 3], "wrapper": 1, "write": [1, 2], "written": 1, "x": [1, 2, 3], "xa": 3, "y": [1, 2, 3], "y0": 1, "yaml": [1, 3, 4], "ydot": 1, "ydot0": 1, "you": [1, 2, 3], "your": [2, 3, 5], "yp": 1, "yp0": 1, "zero": 1, "zeros_lik": 1}, "titles": ["API Reference", "thevenin", "1. YAML file inputs", "2. Dictionary inputs", "Examples", "Summary"], "titleterms": {"an": [2, 3], "api": 0, "build": [2, 3], "class": 1, "construct": [2, 3], "content": 1, "defin": 3, "dictionari": 3, "exampl": 4, "experi": [2, 3], "file": 2, "import": [2, 3], "input": [2, 3], "model": [2, 3], "modul": [2, 3], "packag": 1, "paramet": 3, "refer": 0, "run": [2, 3], "summari": 5, "thevenin": 1, "yaml": 2}}) \ No newline at end of file diff --git a/src/thevenin/__init__.py b/src/thevenin/__init__.py index da89a2e..c8f4be4 100644 --- a/src/thevenin/__init__.py +++ b/src/thevenin/__init__.py @@ -10,9 +10,8 @@ ---------------------------- Documentation is accessible via Python's ``help()`` function which prints docstrings from a package, module, function, class, etc. In addition, you can -access the documentation by calling the built-in ``thevenin.docs()`` method to -open a local website. The website includes search functionality and examples, -beyond the code docstrings. +access the documentation by visiting the website, hosted through GitHub pages. +The website includes search functionality and examples, beyond the docstrings. Viewing documentation using IPython -----------------------------------