Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/877 add battery capacity fault capability #879

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
+137 −0
Open

Feature/877 add battery capacity fault capability #879

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33bfcdb
Add storage capacity fault capability to simple battery module
Dec 19, 2024
906607d
Add test script for simple battery fault
Dec 19, 2024
8cf2283
Add documentation for simple battery fault
Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/Support/bskReleaseNotes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ Version |release|
the added setters and getters must be used.
- Fixed a bug in which the ``MtbEffector.py`` module was not being imported correctly in Python due to lack of ``swig_eigen.i``
include file in ``MtbEffector.i``.
- Added the capability to simulate a fault in the :ref:`simpleBattery` module that reduces the actual storage capacity without directly altering the stated capacity.
- Cleaned up what python packages are required to build BSK (``requirements_dev.txt``),
to run BSK (``requirements.txt``) and to build BSK documentation (``requirements_doc.txt``).
- The BSK install instructions are updated to ask users to install by first ``pip`` installing build
Expand Down
5 changes: 5 additions & 0 deletions src/simulation/power/simpleBattery/simpleBattery.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,8 @@ The next step is to attach one or more :ref:`PowerNodeUsageMsgPayload` instances


For more information on how to set up and use this module, see the simple power system example :ref:`scenarioPowerDemo`.

To simulate a battery capacity fault that reduces the actual storage capacity (without directly altering the stated capacity), users must set up the fault flag::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not very clear what we are doing here. Can you please be more explicit on what is done when a fault is modeled?


battery.fault = True
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be updated to use the private class setter function. Check out
https://avslab.github.io/basilisk/Documentation/moduleTemplates/cppModuleTemplate/cppModuleTemplate.html
to see how to name and document the setter and getter functions.

battery.faultCapacityRatio = 0.5 # 50% of the original capacity
Loading