-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: change to generic .from_file() method in Component class
- Loading branch information
Showing
5 changed files
with
254 additions
and
289 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,73 @@ | ||
|
|
||
|  | ||
|
|
||
| <p style="text-align: center;"> | ||
| <a href="https://github.com/geddy11/sysloss/actions"><img alt="Actions Status" src="https://github.com/geddy11/sysloss/actions/workflows/ci-cd.yml/badge.svg"></a> | ||
| <a href="https://codecov.io/github/geddy11/sysloss"><img alt="Code coverage" src="https://codecov.io/github/geddy11/sysloss/graph/badge.svg?token=9L1ZMN0UET"/></a> | ||
| <a href="https://app.codacy.com/gh/geddy11/sysloss/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img alt="Codacy" src="https://app.codacy.com/project/badge/Grade/37b586ca428240418f0364c15472134b"/></a> | ||
| <a href="https://pypi.org/project/sysloss/"><img alt="PyPI" src="https://img.shields.io/pypi/v/sysloss"></a> | ||
| <a href="https://anaconda.org/conda-forge/sysloss"><img alt="Conda" src="https://anaconda.org/conda-forge/sysloss/badges/version.svg"></a> | ||
| <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> | ||
| <a href="https://www.conventionalcommits.org"><img alt="Conv. commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white"></a> | ||
| <a href="https://doi.org/10.5281/zenodo.11086060"><img alt="Zenodo DOI" src="https://zenodo.org/badge/DOI/10.5281/zenodo.11086060.svg" alt="DOI"></a> | ||
| </p> | ||
|
|
||
| # sysLoss | ||
| sysLoss is a tool for analyzing power trees, system power and losses. From the smallest IoT sensor to large industrial installations. The tool is efficient and easy to use, the analysis result provides a detailed report on voltages, currents, power and efficiency for every component defined in the system. Output format is Pandas DataFrame: Create charts, plots and export to Excel and other formats. | ||
|
|
||
| ## Installation | ||
| ```bash | ||
| $ pip install sysloss | ||
| ``` | ||
| or | ||
| ```bash | ||
| $ conda install conda-forge::sysloss | ||
| ``` | ||
|
|
||
| ## Usage | ||
| ```python | ||
| from sysloss.components import * | ||
| from sysloss.system import System | ||
|
|
||
| bts = System("Bluetooth sensor", Source("CR2032", vo=3.0, rs=10)) | ||
| bts.add_comp("CR2032", comp=Converter("Buck 1.8V", vo=1.8, eff=0.87)) | ||
| bts.add_comp("Buck 1.8V", comp=PLoad("MCU", pwr=13e-3)) | ||
| bts.add_comp("CR2032", comp=Converter("Boost 5V", vo=5.0, eff=0.82)) | ||
| bts.add_comp("Boost 5V", comp=RLoss("RC filter", rs=6.8)) | ||
| bts.add_comp("RC filter", comp=ILoad("Sensor", ii=6e-3)) | ||
| bts.tree() | ||
| ``` | ||
| ``` | ||
| Bluetooth sensor | ||
| └── CR2032 | ||
| ├── Boost 5V | ||
| │ └── RC filter | ||
| │ └── Sensor | ||
| └── Buck 1.8V | ||
| └── MCU | ||
| ``` | ||
| ```python | ||
| df = bts.solve() | ||
| print(df) | ||
| ``` | ||
|  | ||
| ```python | ||
| from sysloss.diagram import make_diag | ||
|
|
||
| make_diag(bts, fname="bts.png") | ||
| ``` | ||
|  | ||
|
|
||
| ## Documentation | ||
| The [documentation](https://sysloss.readthedocs.io/en/latest/Getting%20started.html) includes tutorials in the form of Jupyter notebooks, located in docs/nb. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms. | ||
|
|
||
| ## License | ||
|
|
||
| `sysloss` was created by Geir Drange. It is licensed under the terms of the MIT license. | ||
|
|
||
|  | ||
|
|
||
| <p style="text-align: center;"> | ||
| <a href="https://github.com/geddy11/sysloss/actions"><img alt="Actions Status" src="https://github.com/geddy11/sysloss/actions/workflows/ci-cd.yml/badge.svg"></a> | ||
| <a href="https://codecov.io/github/geddy11/sysloss"><img alt="Code coverage" src="https://codecov.io/github/geddy11/sysloss/graph/badge.svg?token=9L1ZMN0UET"/></a> | ||
| <a href="https://app.codacy.com/gh/geddy11/sysloss/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img alt="Codacy" src="https://app.codacy.com/project/badge/Grade/37b586ca428240418f0364c15472134b"/></a> | ||
| <a href="https://pypi.org/project/sysloss/"><img alt="PyPI" src="https://img.shields.io/pypi/v/sysloss"></a> | ||
| <a href="https://anaconda.org/conda-forge/sysloss"><img alt="Conda" src="https://anaconda.org/conda-forge/sysloss/badges/version.svg"></a> | ||
| <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> | ||
| <a href="https://www.conventionalcommits.org"><img alt="Conv. commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white"></a> | ||
| <a href="https://doi.org/10.5281/zenodo.11086060"><img alt="Zenodo DOI" src="https://zenodo.org/badge/DOI/10.5281/zenodo.11086060.svg" alt="DOI"></a> | ||
| </p> | ||
|
|
||
| # sysLoss | ||
| sysLoss is a tool for analyzing power trees, system power and losses. From the smallest IoT sensor to large industrial installations. The tool is efficient and easy to use, the analysis result provides a detailed report on voltages, currents, power and efficiency for every component defined in the system. Output format is Pandas DataFrame: Create charts, plots and export to Excel and other formats. | ||
|
|
||
| ## Installation | ||
| ```bash | ||
| $ pip install sysloss | ||
| ``` | ||
| or | ||
| ```bash | ||
| $ conda install conda-forge::sysloss | ||
| ``` | ||
|
|
||
| ## Usage | ||
| Analyze the power tree of a simple battery-powered bluetooth sensor: | ||
| ```python | ||
| from sysloss.components import * | ||
| from sysloss.system import System | ||
|
|
||
| bts = System("Bluetooth sensor", Source("CR2032", vo=3.0, rs=10)) | ||
| bts.add_comp("CR2032", comp=Converter("Buck 1.8V", vo=1.8, eff=0.87)) | ||
| bts.add_comp("Buck 1.8V", comp=PLoad("MCU", pwr=13e-3)) | ||
| bts.add_comp("CR2032", comp=Converter("Boost 5V", vo=5.0, eff=0.82)) | ||
| bts.add_comp("Boost 5V", comp=RLoss("RC filter", rs=6.8)) | ||
| bts.add_comp("RC filter", comp=ILoad("Sensor", ii=6e-3)) | ||
| bts.tree() | ||
| ``` | ||
| ``` | ||
| Bluetooth sensor | ||
| └── CR2032 | ||
| ├── Boost 5V | ||
| │ └── RC filter | ||
| │ └── Sensor | ||
| └── Buck 1.8V | ||
| └── MCU | ||
| ``` | ||
| ```python | ||
| df = bts.solve() | ||
| print(df) | ||
| ``` | ||
|  | ||
|
|
||
| Create graphical power tree diagrams: | ||
| ```python | ||
| import sysloss.diagram as sd | ||
|
|
||
| sd.make_diag(bts, fname="bts.png") | ||
| ``` | ||
|  | ||
|
|
||
| ## Documentation | ||
| The [documentation](https://sysloss.readthedocs.io/en/latest/Getting%20started.html) includes tutorials in the form of Jupyter notebooks, located in docs/nb. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms. | ||
|
|
||
| ## License | ||
|
|
||
| `sysloss` was created by Geir Drange. It is licensed under the terms of the MIT license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,53 @@ | ||
| ####################################################################################### | ||
| # A default configuration that will be loaded for all jupyter books | ||
| # See the documentation for help and more options: | ||
| # https://jupyterbook.org/customize/config.html | ||
|
|
||
| ####################################################################################### | ||
| # Book settings | ||
| title : sysLoss # The title of the book. Will be placed in the left navbar. | ||
| author : Geir Drange # The author of the book | ||
| copyright : "2024" # Copyright year to be placed in the footer | ||
| logo : logo.png # A path to the book logo | ||
|
|
||
| # Force re-execution of notebooks on each build. | ||
| # See https://jupyterbook.org/content/execute.html | ||
| execute: | ||
| execute_notebooks: force | ||
|
|
||
| # Define the name of the latex output file for PDF builds | ||
| latex: | ||
| latex_documents: | ||
| targetname: book.tex | ||
|
|
||
| # Add a bibtex file so that we can create citations | ||
| bibtex_bibfiles: | ||
| - references.bib | ||
|
|
||
| # Information about where the book exists on the web | ||
| repository: | ||
| url: https://github.com/geddy11/sysloss # Online location of your book | ||
| path_to_book: docs # Optional path to your book, relative to the repository root | ||
| branch: main # Which branch of the repository should be used when creating links (optional) | ||
|
|
||
| # Add GitHub buttons to your book | ||
| # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository | ||
| html: | ||
| use_issues_button: true | ||
| use_repository_button: true | ||
|
|
||
| # Sphinx autodoc | ||
| sphinx: | ||
| extra_extensions: | ||
| - 'autoapi.extension' | ||
| - 'sphinx.ext.napoleon' | ||
| - 'sphinx.ext.viewcode' | ||
| - 'sphinxcontrib.bibtex' | ||
| config: | ||
| autoapi_dirs: ["../src"] # location to parse for API reference | ||
| autoapi_options: | ||
| ['members', 'undoc-members', "show-module-summary"] | ||
| #html_theme: "sphinx_rtd_theme" | ||
| add_module_names: False | ||
| bibtex_bibfiles: ['references.bib'] | ||
| ####################################################################################### | ||
| # A default configuration that will be loaded for all jupyter books | ||
| # See the documentation for help and more options: | ||
| # https://jupyterbook.org/customize/config.html | ||
|
|
||
| ####################################################################################### | ||
| # Book settings | ||
| title : sysLoss # The title of the book. Will be placed in the left navbar. | ||
| author : Geir Drange # The author of the book | ||
| copyright : "2024" # Copyright year to be placed in the footer | ||
| logo : logo.png # A path to the book logo | ||
|
|
||
| # Force re-execution of notebooks on each build. | ||
| # See https://jupyterbook.org/content/execute.html | ||
| execute: | ||
| execute_notebooks: force | ||
|
|
||
| # Define the name of the latex output file for PDF builds | ||
| latex: | ||
| latex_documents: | ||
| targetname: book.tex | ||
|
|
||
| # Add a bibtex file so that we can create citations | ||
| bibtex_bibfiles: | ||
| - references.bib | ||
|
|
||
| # Information about where the book exists on the web | ||
| repository: | ||
| url: https://github.com/geddy11/sysloss # Online location of your book | ||
| path_to_book: docs # Optional path to your book, relative to the repository root | ||
| branch: main # Which branch of the repository should be used when creating links (optional) | ||
|
|
||
| # Add GitHub buttons to your book | ||
| # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository | ||
| html: | ||
| use_issues_button: true | ||
| use_repository_button: true | ||
|
|
||
| # Sphinx autodoc | ||
| sphinx: | ||
| extra_extensions: | ||
| - 'autoapi.extension' | ||
| - 'sphinx.ext.napoleon' | ||
| - 'sphinx.ext.viewcode' | ||
| - 'sphinxcontrib.bibtex' | ||
| config: | ||
| autoapi_dirs: ["../src"] # location to parse for API reference | ||
| autoapi_options: | ||
| ['members', 'undoc-members', "show-module-summary", 'inherited-members'] | ||
| #html_theme: "sphinx_rtd_theme" | ||
| add_module_names: False | ||
| bibtex_bibfiles: ['references.bib'] | ||
| mathjax_path: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js |
Oops, something went wrong.