shepherd-core 2025.8.1__py3-none-any.whl → 2026.2.1__py3-none-any.whl

shepherd_core/data_models/content/virtual_storage_fixture_mlcc.yaml

@@ -0,0 +1,200 @@
+- datatype: VirtualStorageConfig
+  comment: created by script 'virtual_storage_fixture_creator.py'
+  created: 2025-09-11 19:47:04.433082+02:00
+  parameters:
+    id: 419607010409477957
+    name: Capacitor_10uF_6.3V
+    description: MLCC-Capacitor with R_leak & R_series and planned DC-Bias-Effect,
+      R_leak = 9780.000 Ohm
+    comment: null
+    created: 2025-09-11 19:47:04.396971
+    updated_last: 2025-09-11 19:47:04.396972
+    owner: NES Lab
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    SoC_init: 0.8
+    q_As: 6.299999999999999e-05
+    p_VOC:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 6.3
+    - 0.0
+    - 0.0
+    p_Rs:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_rce: 1.0
+    kdash: 2.2250738585072014e-308
+    R_leak_Ohm: 9780000.0
+- datatype: VirtualStorageConfig
+  comment: created by script 'virtual_storage_fixture_creator.py'
+  created: 2025-09-11 19:47:04.433129+02:00
+  parameters:
+    id: 1124861888666195714
+    name: Capacitor_33uF_6.3V
+    description: MLCC-Capacitor with R_leak & R_series and planned DC-Bias-Effect,
+      R_leak = 2963.636 Ohm
+    comment: null
+    created: 2025-09-11 19:47:04.399112
+    updated_last: 2025-09-11 19:47:04.399113
+    owner: NES Lab
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    SoC_init: 0.8
+    q_As: 0.00020789999999999996
+    p_VOC:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 6.3
+    - 0.0
+    - 0.0
+    p_Rs:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_rce: 1.0
+    kdash: 2.2250738585072014e-308
+    R_leak_Ohm: 2963636.3636363638
+- datatype: VirtualStorageConfig
+  comment: created by script 'virtual_storage_fixture_creator.py'
+  created: 2025-09-11 19:47:04.433168+02:00
+  parameters:
+    id: 660779979738076740
+    name: Capacitor_47uF_6.3V
+    description: MLCC-Capacitor with R_leak & R_series and planned DC-Bias-Effect,
+      R_leak = 2080.851 Ohm
+    comment: null
+    created: 2025-09-11 19:47:04.399155
+    updated_last: 2025-09-11 19:47:04.399156
+    owner: NES Lab
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    SoC_init: 0.8
+    q_As: 0.0002961
+    p_VOC:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 6.3
+    - 0.0
+    - 0.0
+    p_Rs:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_rce: 1.0
+    kdash: 2.2250738585072014e-308
+    R_leak_Ohm: 2080851.0638297873
+- datatype: VirtualStorageConfig
+  comment: created by script 'virtual_storage_fixture_creator.py'
+  created: 2025-09-11 19:47:04.433200+02:00
+  parameters:
+    id: 51678003530735820
+    name: Capacitor_100uF_6.3V
+    description: MLCC-Capacitor with R_leak & R_series and planned DC-Bias-Effect,
+      R_leak = 978.000 Ohm
+    comment: null
+    created: 2025-09-11 19:47:04.399199
+    updated_last: 2025-09-11 19:47:04.399200
+    owner: NES Lab
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    SoC_init: 0.8
+    q_As: 0.0006299999999999999
+    p_VOC:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 6.3
+    - 0.0
+    - 0.0
+    p_Rs:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_rce: 1.0
+    kdash: 2.2250738585072014e-308
+    R_leak_Ohm: 978000.0

shepherd_core/data_models/content/virtual_storage_fixture_param_experiments.py

@@ -0,0 +1,151 @@
+"""Script to determine proper parameters for the fixtures.
+
+This is done by comparing data from datasheets or online sources
+with the resulting behavior of the model.
+"""
+
+from datetime import timedelta
+
+from virtual_storage_config import VirtualStorageConfig
+
+from shepherd_core import log
+from shepherd_core.vsource.virtual_storage_models_kibam import ModelKiBaMPlus
+from shepherd_core.vsource.virtual_storage_simulator import StorageSimulator
+
+
+def experiment_self_discharge_lead_acid() -> None:
+    """Determine leakage resistor and plot behavior.
+
+    Datasheet of LEOCH LP12-1.2AH expects 3 to 20 % discharge/month
+    -> chosen 5 % for the fixtures
+    """
+    dt_s = 10
+    SoC_init = 1.0
+    SoC_final = 0.95
+    duration = timedelta(weeks=4)
+    R_leak1 = VirtualStorageConfig.lead_acid(q_mAh=1).calc_R_leak_battery(
+        duration, SoC_0=SoC_init, SoC_final=SoC_final
+    )
+    R_leak2 = (
+        VirtualStorageConfig.lead_acid(q_mAh=10).calc_R_leak_battery(
+            duration, SoC_0=SoC_init, SoC_final=SoC_final
+        )
+        * 10
+    )
+    log.info("R_leak_lead \t= %.0f Ohm [@1mAh]", R_leak1)
+    if round(R_leak1) != round(R_leak2):
+        raise ValueError("Values should match")
+    cfg1 = VirtualStorageConfig.lead_acid(q_mAh=1200)
+    sim = StorageSimulator(
+        models=[ModelKiBaMPlus(SoC_init=SoC_init, cfg=cfg1, dt_s=dt_s)],
+        dt_s=dt_s,
+    )
+
+    def step(_t: float, _s: float, _v: float) -> float:
+        return 0
+
+    sim.run(fn=step, duration_s=duration.total_seconds())
+    sim.plot(
+        f"Experiment {cfg1.name}, self-discharge, "
+        f"SoC {SoC_init:.3f} to {SoC_final:.3f} in {duration.total_seconds()} s"
+    )
+
+
+def experiment_self_discharge_lipo() -> None:
+    """Determine leakage resistor and plot behavior.
+
+    According to wikipedia a typical Lipo looses 5 % in 4 weeks.
+    """
+    dt_s = 10
+    SoC_init = 1.0
+    SoC_final = 0.95
+    duration = timedelta(weeks=4)
+    R_leak1 = VirtualStorageConfig.lipo(q_mAh=1).calc_R_leak_battery(
+        duration, SoC_0=SoC_init, SoC_final=SoC_final
+    )
+    R_leak2 = (
+        VirtualStorageConfig.lipo(q_mAh=10).calc_R_leak_battery(
+            duration, SoC_0=SoC_init, SoC_final=SoC_final
+        )
+        * 10
+    )
+    log.info("R_leak_lipo \t= %.0f Ohm [@1mAh]", R_leak1)
+    if round(R_leak1) != round(R_leak2):
+        raise ValueError("Values should match")
+    cfg1 = VirtualStorageConfig.lipo(q_mAh=860)
+    sim = StorageSimulator(
+        models=[ModelKiBaMPlus(SoC_init=SoC_init, cfg=cfg1, dt_s=dt_s)],
+        dt_s=dt_s,
+    )
+
+    def step(_t: float, _s: float, _v: float) -> float:
+        return 0
+
+    sim.run(fn=step, duration_s=duration.total_seconds())
+    sim.plot(
+        f"Experiment {cfg1.name}, self-discharge, "
+        f"SoC {SoC_init:.3f} to {SoC_final:.3f} in {duration.total_seconds()} s"
+    )
+
+
+def experiment_self_discharge_tantal_avx() -> None:
+    """Discharge Experiment: measured 5V to 3V decrease in 100 s.
+
+    https://github.com/orgua/bq_characteristics/tree/main/eval_kit_behavior_var1#capacitor
+    Note: first approach should be correct, but the second matches the plot
+    """
+    dt_s = 0.1
+    cfg0 = VirtualStorageConfig.capacitor(C_uF=100, V_rated=6.3)
+    duration = timedelta(seconds=100)
+    R_leak = cfg0.calc_R_leak_battery(duration, SoC_final=3.0 / 5.0)
+    log.info("R_leak_tantal \t= %.0f Ohm [@1uF]", R_leak * 100)
+    cfg1 = VirtualStorageConfig.capacitor(
+        C_uF=100, V_rated=6.3, R_leak_Ohm=R_leak, name="AVX TAJB107M006RNJ"
+    )
+    SoC_init = cfg1.approximate_SoC(V_OC=5.0)
+    sim = StorageSimulator(
+        models=[ModelKiBaMPlus(SoC_init=SoC_init, cfg=cfg1, dt_s=dt_s)],
+        dt_s=dt_s,
+    )
+
+    def step(_t: float, _s: float, _v: float) -> float:
+        return 0
+
+    sim.run(fn=step, duration_s=duration.total_seconds())
+    sim.plot(f"Experiment Tantal AVX, self-discharge {duration.total_seconds()} s")
+
+
+def experiment_self_discharge_mlcc_tayo() -> None:
+    """Discharge Experiment: measured 5V to 1.8V decrease in 100 s.
+
+    Taiyo Yuden, JMK316ABJ107ML
+    https://github.com/orgua/bq_characteristics/tree/main/eval_kit_behavior_var1#capacitor
+    """
+    dt_s = 0.1
+    duration = timedelta(seconds=100)
+    cfg0 = VirtualStorageConfig.capacitor(C_uF=74, V_rated=6.3)
+    R_leak = cfg0.calc_R_leak_battery(duration, SoC_final=1.8 / 5.0)
+    log.info("R_leak_mlcc \t= %.0f Ohm [@1uF]", R_leak * 74)
+    R_leak = cfg0.calc_R_leak_capacitor(duration, SoC_final=1.8 / 5.0)
+    log.info("R_leak_mlcc \t= %.0f Ohm [@1uF]", R_leak * 74)
+    cfg1 = VirtualStorageConfig.capacitor(
+        C_uF=74, V_rated=6.3, R_leak_Ohm=R_leak, name="Taiyo JMK316ABJ107ML"
+    )
+    SoC_init = cfg1.approximate_SoC(V_OC=5.0)
+    sim = StorageSimulator(
+        models=[ModelKiBaMPlus(SoC_init=SoC_init, cfg=cfg1, dt_s=dt_s)],
+        dt_s=dt_s,
+    )
+
+    def step(_t: float, _s: float, _v: float) -> float:
+        return 0
+
+    sim.run(fn=step, duration_s=duration.total_seconds())
+    sim.plot(f"Experiment MLCC Tayo, self-discharge {duration.total_seconds()} s")
+
+
+if __name__ == "__main__":
+    experiment_self_discharge_lead_acid()
+    experiment_self_discharge_lipo()
+    experiment_self_discharge_tantal_avx()
+    experiment_self_discharge_mlcc_tayo()

shepherd_core/data_models/content/virtual_storage_fixture_super.yaml

@@ -0,0 +1,150 @@
+- datatype: VirtualStorageConfig
+  comment: created by script 'virtual_storage_fixture_creator.py'
+  created: 2025-09-11 19:47:04.438729+02:00
+  parameters:
+    id: 331843882344025539
+    name: Maxwell BCAP0025 P300 X11
+    description: SuperCapacitor with typically 1000 hours / 500 k cycles (not modeled),
+      R_leak = 54.545 Ohm, R_serial = 0 Ohm
+    comment: null
+    created: 2025-09-11 19:47:04.399243
+    updated_last: 2025-09-11 19:47:04.399244
+    owner: NES Lab
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    SoC_init: 0.8
+    q_As: 75.0
+    p_VOC:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 3.0
+    - 0.0
+    - 0.0
+    p_Rs:
+    - 0.0
+    - 0.0
+    - 0.017
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_rce: 1.0
+    kdash: 2.2250738585072014e-308
+    R_leak_Ohm: 54545.454545454544
+- datatype: VirtualStorageConfig
+  comment: created by script 'virtual_storage_fixture_creator.py'
+  created: 2025-09-11 19:47:04.438772+02:00
+  parameters:
+    id: 1065295619710061461
+    name: Abracon ADCM-S06R0SA126RB
+    description: SuperCapacitor with typically 1000 hours / 500 k cycles (not modeled),
+      R_leak = 75.000 Ohm, R_serial = 0 Ohm
+    comment: null
+    created: 2025-09-11 19:47:04.399283
+    updated_last: 2025-09-11 19:47:04.399284
+    owner: NES Lab
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    SoC_init: 0.8
+    q_As: 72.0
+    p_VOC:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 6.0
+    - 0.0
+    - 0.0
+    p_Rs:
+    - 0.0
+    - 0.0
+    - 0.09
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_rce: 1.0
+    kdash: 2.2250738585072014e-308
+    R_leak_Ohm: 75000.0
+- datatype: VirtualStorageConfig
+  comment: created by script 'virtual_storage_fixture_creator.py'
+  created: 2025-09-11 19:47:04.438806+02:00
+  parameters:
+    id: 1130328829082407568
+    name: AVX SCMT32F755SRBA0
+    description: SuperCapacitor with typically 1000 hours / 500 k cycles (not modeled),
+      R_leak = 76.923 Ohm, R_serial = 0 Ohm
+    comment: null
+    created: 2025-09-11 19:47:04.399324
+    updated_last: 2025-09-11 19:47:04.399324
+    owner: NES Lab
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    SoC_init: 0.8
+    q_As: 41.25
+    p_VOC:
+    - 0.0
+    - 0.0
+    - 0.0
+    - 5.5
+    - 0.0
+    - 0.0
+    p_Rs:
+    - 0.0
+    - 0.0
+    - 0.09
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtS:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_RtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_CtL:
+    - 0.0
+    - 0.0
+    - 0.0
+    p_rce: 1.0
+    kdash: 2.2250738585072014e-308
+    R_leak_Ohm: 76923.07692307692