fastsim 2.0.10__tar.gz

fastsim-2.0.10/LICENSE

@@ -0,0 +1,14 @@
+Future Automotive Systems Technology Simulator (FASTSim(TM)) Copyright (c) 2020 Alliance for Sustainable Energy, LLC All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “FASTSim”. Except to comply with the foregoing, the term “FASTSim”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.
+
+4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

fastsim-2.0.10/LICENSE.md

@@ -0,0 +1,14 @@
+Future Automotive Systems Technology Simulator (FASTSim(TM)) Copyright (c) 2020 Alliance for Sustainable Energy, LLC All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “FASTSim”. Except to comply with the foregoing, the term “FASTSim”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.
+
+4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

fastsim-2.0.10/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE LICENSE.md README.md setup.py
+include pyproject.toml rust/Cargo.toml rust/fastsim-py/Cargo.toml rust/fastsim-core/Cargo.toml rust/fastsim-core/proc-macros/Cargo.toml
+recursive-include rust/fastsim-py/src *
+recursive-include rust/fastsim-core/src *
+recursive-include rust/fastsim-core/proc-macros/src *
+recursive-include fastsim/resources *
+recursive-include fastsim/docs *

fastsim-2.0.10/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.1
+Name: fastsim
+Version: 2.0.10
+Summary: Tool for modeling vehicle powertrains
+Author-email: MBAP Group <fastsim@nrel.gov>
+Project-URL: Homepage, https://www.nrel.gov/transportation/fastsim.html
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: <3.11,>=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+License-File: LICENSE.md
+
+[docs/README.md](fastsim/docs/README.md)

fastsim-2.0.10/README.md

@@ -0,0 +1 @@
+[docs/README.md](fastsim/docs/README.md)

fastsim-2.0.10/fastsim/__init__.py

@@ -0,0 +1,62 @@
+"""Package containing modules for running FASTSim.
+For example usage, see """
+
+from pathlib import Path
+import sys
+import logging
+import traceback
+
+def package_root() -> Path:
+    """Returns the package root directory."""
+    return Path(__file__).parent
+
+# Set up logging
+logging.basicConfig(
+    format="%(asctime)s.%(msecs)03d | %(filename)s:%(lineno)s | %(levelname)s: %(message)s",
+    datefmt="%Y-%m-%d %H:%M:%S",
+)
+logger = logging.getLogger(__name__)
+
+# Override exception handler
+def _exception_handler(exc_type, exc_value, exc_traceback):
+    # Handle exception normally if it's a KeyboardInterrupt
+    if issubclass(exc_type, KeyboardInterrupt):
+        sys.__excepthook__(exc_type, exc_value, exc_traceback)
+        return
+    # Handle exception normally if error originates outside of FASTSim
+    exc_filepath = Path(traceback.extract_tb(exc_traceback)[-1].filename)
+    if not package_root() in exc_filepath.parents:
+        sys.__excepthook__(exc_type, exc_value, exc_traceback)
+        return
+    # Log error if it comes from FASTSim
+    logger.error("uncaught exception", exc_info=(
+        exc_type, exc_value, exc_traceback))
+sys.excepthook = _exception_handler
+
+from . import parameters as params
+from . import utilities as utils
+from . import simdrive, vehicle, cycle, calibration, tests
+from . import calibration as cal
+from .resample import resample
+from . import auxiliaries
+
+from pkg_resources import get_distribution
+
+__version__ = get_distribution('fastsim').version
+
+__doc__ += f"{Path(__file__).parent / 'docs/README.md'}"
+
+try:
+    import fastsimrust as fsr
+except ImportError:
+    logger.warn("fastsimrust not installed")
+else:
+    # Enable np.array() on array structs
+    import numpy as np
+
+    def _as_numpy_array(self, *args, **kwargs):
+        return np.array(list(self), *args, **kwargs)
+    setattr(fsr.Pyo3ArrayF64, "__array__", _as_numpy_array)
+    setattr(fsr.Pyo3ArrayU32, "__array__", _as_numpy_array)
+    setattr(fsr.Pyo3ArrayBool, "__array__", _as_numpy_array)
+    setattr(fsr.Pyo3VecF64, "__array__", _as_numpy_array)

fastsim-2.0.10/fastsim/auxiliaries.py

@@ -0,0 +1,232 @@
+"""Auxiliary functions that require fastsim and provide faster access FASTSim vehicle properties."""
+import fastsim as fsim
+from fastsim.vehicle import Vehicle
+from fastsim import parameters as params
+from scipy.optimize import minimize, curve_fit
+import numpy as np
+import matplotlib.pyplot as plt
+from typing import Tuple, List
+
+from fastsim.utilities import get_rho_air
+
+props = params.PhysicalProperties()
+R_air = 287  # J/(kg*K)
+
+
+def abc_to_drag_coeffs(veh: Vehicle,
+                       a_lbf: float, b_lbf__mph: float, c_lbf__mph2: float,
+                       custom_rho: bool = False,
+                       custom_rho_temp_degC: float = 20.,
+                       custom_rho_elevation_m: float = 180.,
+                       simdrive_optimize: bool = True,
+                       show_plots: bool = False,
+                       use_rust=True) -> Tuple[float, float]:
+    """For a given vehicle and target A, B, and C
+    coefficients; calculate and return drag and rolling resistance
+    coefficients.
+
+    Arguments:
+    ----------
+    veh: vehicle.Vehicle with all parameters correct except for drag and rolling resistance coefficients
+    a_lbf, b_lbf__mph, c_lbf__mph2: coastdown coefficients for road load [lbf] vs speed [mph]
+    custom_rho: if True, use `fastsim.utilities.get_rho_air()` to calculate the current ambient density
+    custom_rho_temp_degC: ambient temperature [degree C] for `get_rho_air()`; 
+        will only be used when `custom_rho` is True
+    custom_rho_elevation_m: location elevation [degree C] for `get_rho_air()`; 
+        will only be used when `custom_rho` is True; default value is elevation of Chicago, IL
+    simdrive_optimize: if True, use `SimDrive` to optimize the drag and rolling resistance; 
+        otherwise, directly use target A, B, C to calculate the results
+    show_plots: if True, plots are shown
+    use_rust: if True, use rust implementation of drag coefficient calculation.
+    """
+
+    # TODO: allows air density read APIs for whole project; `get_rho_air()` not used for `SimDrive` yet
+    cur_ambient_air_density_kg__m3 = get_rho_air(
+        custom_rho_temp_degC, custom_rho_elevation_m) if custom_rho else props.air_density_kg_per_m3
+
+    vmax_mph = 70.0
+
+    a_newton = a_lbf * params.N_PER_LBF
+    b_newton__mps = b_lbf__mph * params.N_PER_LBF * params.MPH_PER_MPS
+    c_newton__mps2 = c_lbf__mph2 * params.N_PER_LBF * \
+        params.MPH_PER_MPS * params.MPH_PER_MPS
+
+    cd_len = 300
+
+    cyc = fsim.cycle.Cycle.from_dict({
+        'time_s': np.arange(0, cd_len),
+        'mps': np.linspace(vmax_mph / params.MPH_PER_MPS, 0, cd_len)
+    })
+
+    if use_rust:
+        cyc = cyc.to_rust()
+        veh = veh.to_rust()
+
+    # polynomial function for pounds vs speed
+    dyno_func_lb = np.poly1d([c_lbf__mph2, b_lbf__mph, a_lbf])
+
+    def get_err(x):
+        """fastsim-style solution for drag force on vehicle.
+        Arguments:
+        ---------
+        x: (speed: array of vehicle speeds [mps], dragCoef: drag coefficient [-])
+        wheelRrCoef: rolling resistance coefficient [-]
+        """
+        drag_coef, wheel_rr_coef = x
+        veh.drag_coef = drag_coef
+        veh.wheel_rr_coef = wheel_rr_coef
+
+        if use_rust:
+            sd_coast = fsim.simdrive.RustSimDrive(cyc, veh)
+        else:
+            sd_coast = fsim.simdrive.SimDrive(cyc, veh)
+        sd_coast.impose_coast = [True] * len(sd_coast.impose_coast)
+        sd_coast.sim_drive()
+
+        cutoff = np.where(np.array(sd_coast.mps_ach) < 0.1)[0][0]
+
+        err = fsim.cal.get_error_val(
+            (1000 * (np.array(sd_coast.drag_kw) + np.array(sd_coast.rr_kw)) /
+                np.array(sd_coast.mps_ach))[:cutoff],
+            (dyno_func_lb(sd_coast.mph_ach) * fsim.params.N_PER_LBF)[:cutoff],
+            np.array(cyc.time_s)[:cutoff],
+        )
+
+        return err
+
+    if simdrive_optimize:
+        res = minimize(get_err, x0=np.array([0.3, 0.01]))
+        (drag_coef, wheel_rr_coef) = res.x
+
+        # TODO: Surpress unnecessary excessive warnings on screen
+
+    else:
+        drag_coef = c_newton__mps2 / \
+            (0.5 * veh.frontal_area_m2 * cur_ambient_air_density_kg__m3)
+        wheel_rr_coef = a_newton / veh.veh_kg / props.a_grav_mps2
+
+    veh.drag_coef, veh.wheel_rr_coef = drag_coef, wheel_rr_coef
+
+    sd_coast = fsim.simdrive.RustSimDrive(
+        cyc, veh) if use_rust else fsim.simdrive.SimDrive(cyc, veh)
+    sd_coast.impose_coast = [True] * len(sd_coast.impose_coast)
+    sd_coast.sim_drive()
+
+    cutoff_val = np.where(np.array(sd_coast.mps_ach) < 0.1)[0][0]
+
+    if show_plots:
+        plt.figure()
+        plt.plot(
+            np.array(sd_coast.mph_ach)[:cutoff_val],
+            (1000 * (np.array(sd_coast.drag_kw) + np.array(sd_coast.rr_kw)) /
+             np.array(sd_coast.mps_ach) / fsim.params.N_PER_LBF)[:cutoff_val],
+            label='sim_drive simulated road load')
+        plt.plot(np.array(sd_coast.mph_ach)[:cutoff_val], (dyno_func_lb(
+            sd_coast.mph_ach))[:cutoff_val], label='ABCs calculated road load')
+        plt.legend()
+        plt.xlabel('Speed [mph]')
+        plt.ylabel('Road Load [lb]')
+        plt.title("Simulated vs Calculated Road Load with Speed")
+        plt.show()
+
+        fig, ax = plt.subplots(2, 1, sharex=True)
+        ax[0].plot(np.array(cyc.time_s)[:cutoff_val],
+                   (1000 * (np.array(sd_coast.drag_kw) + np.array(sd_coast.rr_kw)
+                            ) / np.array(sd_coast.mps_ach))[:cutoff_val]
+                   )
+        ax[0].set_ylabel("Road Load [N]")
+
+        ax[-1].plot(np.array(cyc.time_s)[:cutoff_val],
+                    np.array(sd_coast.mph_ach)[:cutoff_val])
+        ax[-1].set_ylabel("mph")
+        ax[-1].set_xlabel('Time [s]')
+        plt.show()
+    return drag_coef, wheel_rr_coef
+
+
+def drag_coeffs_to_abc(veh,
+                       custom_rho: bool = False,
+                       custom_rho_temp_degC: float = 20.,
+                       custom_rho_elevation_m: float = 180.,
+                       fit_with_curve: bool = False,
+                       show_plots: bool = False) -> Tuple[float, float, float]:
+    """For a given vehicle mass, frontal area, dragCoef, and wheelRrCoef,
+    calculate and return ABCs.
+
+    Arguments:
+    ----------
+    veh: vehicle.Vehicle with correct drag and rolling resistance
+    custom_rho: if True, use `fastsim.utilities.get_rho_air()` to calculate the current ambient density
+    custom_rho_temp_degC: ambient temperature [degree C] for `get_rho_air()`; will only be used when `custom_rho` is True
+    custom_rho_elevation_m: location elevation [degree C] for `get_rho_air()`; will only be used when `custom_rho` is True; default value is elevation of Chicago, IL
+    fit_with_curve: if True, use `scipy.curve_fit` to get A, B, Cs; otherwise, directly calculate A, B, Cs from given drag and rolling resistance
+    show_plots: if True, plots are shown
+
+    Returns:
+    a_lbf, b_lbf__mph, c_lbf__mph2: coastdown coefficients for road load [lbf] vs speed [mph]
+    """
+    # TODO: allows air density read APIs for whole project; `get_rho_air()` not used for `SimDrive` yet
+    cur_ambient_air_density_kg__m3 = get_rho_air(
+        custom_rho_temp_degC, custom_rho_elevation_m) if custom_rho else props.air_density_kg_per_m3
+
+    vmax_mph = 70.0
+
+    speed_mph = np.linspace(0, vmax_mph, 500)
+    veh_kg = veh.veh_kg
+    veh_fa_m2 = veh.frontal_area_m2
+    drag_coef = veh.drag_coef
+    wheel_rr_coef = veh.wheel_rr_coef
+
+    c_newton__mps2 = drag_coef * \
+        (0.5 * veh_fa_m2 * cur_ambient_air_density_kg__m3)
+    b_newton__mps = 0.0
+    a_newton = wheel_rr_coef * veh_kg * props.a_grav_mps2
+
+    def model_func_lb(speed_mps, drag_coef, wheel_rr_coef):
+        """fastsim-style solution for drag force on vehicle.
+        Arguments:
+        ---------
+        speed: array of vehicle speeds [mps]
+        dragCoef: drag coefficient [-]
+        wheelRrCoef: rolling resistance coefficient [-]
+        """
+        out = (veh_kg * props.a_grav_mps2 * wheel_rr_coef +
+               0.5 * cur_ambient_air_density_kg__m3 * drag_coef * veh_fa_m2
+               * speed_mps ** 2) / 4.448
+        return out
+
+    model_lb = model_func_lb(
+        speed_mph / params.MPH_PER_MPS, drag_coef, wheel_rr_coef)
+
+    # polynomial function for pounds vs speed
+    def dyno_func_lb(speed_mph, a, b, c):
+        return np.poly1d([c, b, a])(speed_mph)
+    if fit_with_curve:
+        (a_lbf, b_lbf__mph, c_lbf__mph2), pcov = curve_fit(dyno_func_lb,
+                                                           xdata=speed_mph,
+                                                           ydata=model_lb,
+                                                           p0=[10, 0.1, 0.01])
+    else:
+        a_lbf = a_newton / params.N_PER_LBF
+        b_lbf__mph = b_newton__mps / params.N_PER_LBF / params.MPH_PER_MPS
+        c_lbf__mph2 = c_newton__mps2 / params.N_PER_LBF / \
+            params.MPH_PER_MPS / params.MPH_PER_MPS
+    dyno_lb = dyno_func_lb(speed_mph, a_lbf, b_lbf__mph, c_lbf__mph2)
+
+    if show_plots:
+        plt.figure()
+        plt.plot(speed_mph, dyno_lb, label='dyno')
+        plt.plot(speed_mph, model_lb, label='model', linestyle='--')
+        plt.legend()
+        plt.xlabel('Speed [mph]')
+        plt.ylabel('Road Load [lb]')
+        plt.show()
+
+    return a_lbf, b_lbf__mph, c_lbf__mph2
+
+
+def set_nested_values(nested_struct, **kwargs):
+    nested_struct.reset_orphaned()
+    for key, value in kwargs.items():
+        setattr(nested_struct, key, value)
+    return nested_struct