setuav-pythrust 0.1.0__tar.gz

setuav_pythrust-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if distributed along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

setuav_pythrust-0.1.0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: setuav-pythrust
+Version: 0.1.0
+Summary: Electric propulsion system co-design, analysis, and optimization framework for UAVs.
+Author: Hüseyin Karakaya
+License: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20
+Requires-Dist: scipy>=1.7
+Provides-Extra: plot
+Requires-Dist: matplotlib>=3.4; extra == "plot"
+Provides-Extra: pybamm
+Requires-Dist: pybamm>=25.0; extra == "pybamm"
+Provides-Extra: openmdao
+Requires-Dist: openmdao>=3.20.0; extra == "openmdao"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+![PyThrust Banner](docs/images/PyThrust_banner.png)
+
+# PyThrust
+
+PyThrust is an open-source framework for electric propulsion system analysis, co-design, and parameter optimization in UAV applications. It can be used for multidisciplinary design optimization (MDO) within OpenMDAO. It includes steady-state performance solvers, auto-tuning calibration tools to fit manufacturer test data, and database search tools to map theoretical designs onto real-world brushless motor and propeller catalogs.
+
+## Design and Analysis Visualization
+
+| 1. Propulsion Co-Design Optimization | 2. Propulsion Calibration & Auto-Tuning |
+| :---: | :---: |
+| ![Propulsion Co-Design Optimization](docs/images/optimize_and_plot_results.png) | ![Propulsion Calibration & Auto-Tuning Results](docs/images/calibration_results.png) |
+| **3. Propeller Aerodynamic Coefficients** | **4. Hover Efficiency Heatmap** |
+| ![Propeller Aerodynamic Coefficients](docs/images/propeller_coefficients.png) | ![Hover Efficiency Heatmap](docs/images/efficiency_heatmap.png) |
+
+### 5. PyBaMM Electrochemical Battery Simulation (Dynamic Load)
+![PyBaMM Electrochemical Battery Simulation](docs/images/pybamm_mission_results.png)
+
+## Documentation
+
+Please see the [docs/](docs/) folder for design specifications, core mathematical model descriptions, and database details.
+
+## License
+
+PyThrust is licensed under the Apache License, Version 2.0 (the "License"). See [LICENSE](LICENSE) for the full license.
+
+## Copyright
+
+Copyright (c) 2026 Hüseyin Karakaya. All rights reserved.

setuav_pythrust-0.1.0/README.md

@@ -0,0 +1,28 @@
+![PyThrust Banner](docs/images/PyThrust_banner.png)
+
+# PyThrust
+
+PyThrust is an open-source framework for electric propulsion system analysis, co-design, and parameter optimization in UAV applications. It can be used for multidisciplinary design optimization (MDO) within OpenMDAO. It includes steady-state performance solvers, auto-tuning calibration tools to fit manufacturer test data, and database search tools to map theoretical designs onto real-world brushless motor and propeller catalogs.
+
+## Design and Analysis Visualization
+
+| 1. Propulsion Co-Design Optimization | 2. Propulsion Calibration & Auto-Tuning |
+| :---: | :---: |
+| ![Propulsion Co-Design Optimization](docs/images/optimize_and_plot_results.png) | ![Propulsion Calibration & Auto-Tuning Results](docs/images/calibration_results.png) |
+| **3. Propeller Aerodynamic Coefficients** | **4. Hover Efficiency Heatmap** |
+| ![Propeller Aerodynamic Coefficients](docs/images/propeller_coefficients.png) | ![Hover Efficiency Heatmap](docs/images/efficiency_heatmap.png) |
+
+### 5. PyBaMM Electrochemical Battery Simulation (Dynamic Load)
+![PyBaMM Electrochemical Battery Simulation](docs/images/pybamm_mission_results.png)
+
+## Documentation
+
+Please see the [docs/](docs/) folder for design specifications, core mathematical model descriptions, and database details.
+
+## License
+
+PyThrust is licensed under the Apache License, Version 2.0 (the "License"). See [LICENSE](LICENSE) for the full license.
+
+## Copyright
+
+Copyright (c) 2026 Hüseyin Karakaya. All rights reserved.

setuav_pythrust-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "setuav-pythrust"
+dynamic = ["version"]
+description = "Electric propulsion system co-design, analysis, and optimization framework for UAVs."
+readme = "README.md"
+authors = [
+    { name = "Hüseyin Karakaya" }
+]
+license = { text = "Apache-2.0" }
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "numpy>=1.20",
+    "scipy>=1.7",
+]
+
+[project.optional-dependencies]
+plot = [
+    "matplotlib>=3.4",
+]
+pybamm = [
+    "pybamm>=25.0",
+]
+openmdao = [
+    "openmdao>=3.20.0",
+]
+dev = [
+    "pytest>=7.0",
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "pythrust.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["pythrust*"]

setuav_pythrust-0.1.0/pythrust/__init__.py

@@ -0,0 +1,4 @@
+"""PyThrust package."""
+
+__version__ = "0.1.0"
+

setuav_pythrust-0.1.0/pythrust/motors/__init__.py

@@ -0,0 +1,6 @@
+"""Motor database and lookup utilities."""
+
+from .database import (  # noqa: F401
+    MotorEntry,
+    MotorDatabase,
+)

setuav_pythrust-0.1.0/pythrust/motors/database.py

@@ -0,0 +1,130 @@
+"""Brushless motor database loader and query interface."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+import json
+from typing import Dict, List, Optional
+from pythrust.propulsion.models import MotorSpec
+
+
+@dataclass(frozen=True)
+class MotorEntry:
+    """A database entry for a single brushless motor."""
+    id: str
+    name: str
+    manufacturer: str
+    kv: float
+    resistance: float
+    io: float
+    max_current: float
+    weight_g: float
+    max_power: float
+    io_voltage: float
+
+    def to_spec(self) -> MotorSpec:
+        """Convert the database entry to a PyThrust MotorSpec object."""
+        return MotorSpec(
+            kv_rpm_per_v=self.kv,
+            resistance_ohm=self.resistance,
+            no_load_current_a=self.io,
+            current_max_a=self.max_current,
+            no_load_voltage_v=self.io_voltage,
+        )
+
+
+class MotorDatabase:
+    """Load and query brushless motor database from JSON files."""
+
+    def __init__(self) -> None:
+        """Create an empty motor database."""
+        self._entries: Dict[str, MotorEntry] = {}
+        self._loaded = False
+
+    @property
+    def is_loaded(self) -> bool:
+        """Return True if a database has been successfully loaded."""
+        return self._loaded
+
+    @property
+    def motor_count(self) -> int:
+        """Return the number of motors in the database."""
+        return len(self._entries)
+
+    def list_motors(self) -> List[str]:
+        """Return sorted unique motor IDs in the database."""
+        return sorted(self._entries.keys())
+
+    def get(self, motor_id: str) -> Optional[MotorEntry]:
+        """Get a motor entry by its unique ID."""
+        return self._entries.get(motor_id)
+
+    def load(self, data_dir: Path) -> bool:
+        """Load all motor JSON entries from a dataset directory."""
+        data_dir = Path(data_dir)
+        if not data_dir.exists():
+            self._loaded = False
+            return False
+
+        self._entries.clear()
+        
+        # Recursively search for and load all .json files under the directory
+        for json_path in sorted(data_dir.glob("**/*.json")):
+            self.load_entry(json_path)
+
+        self._loaded = bool(self._entries)
+        return self._loaded
+
+    def load_entry(self, json_path: Path) -> Optional[MotorEntry]:
+        """Load a single motor JSON file and store its entry."""
+        json_path = Path(json_path)
+        if not json_path.exists():
+            return None
+        try:
+            with open(json_path, "r", encoding="utf-8") as f:
+                m = json.load(f)
+            
+            entry = MotorEntry(
+                id=m.get("id", ""),
+                name=m.get("name", "Unknown"),
+                manufacturer=m.get("manufacturer", "Unknown"),
+                kv=float(m.get("kv", 0.0)),
+                resistance=float(m.get("resistance", 0.0)),
+                io=float(m.get("io", 0.0)),
+                max_current=float(m.get("max_current", 0.0)),
+                weight_g=float(m.get("weight_g", 0.0)),
+                max_power=float(m.get("max_power", 0.0)),
+                io_voltage=float(m.get("io_voltage", 10.0)),
+            )
+            if entry.id:
+                self._entries[entry.id] = entry
+                self._loaded = True
+                return entry
+        except Exception:
+            pass
+        return None
+
+    def search(
+        self,
+        min_kv: Optional[float] = None,
+        max_kv: Optional[float] = None,
+        min_max_current: Optional[float] = None,
+        min_weight: Optional[float] = None,
+        max_weight: Optional[float] = None,
+    ) -> List[MotorEntry]:
+        """Search and filter motors in the database matching specified criteria."""
+        results = []
+        for entry in self._entries.values():
+            if min_kv is not None and entry.kv < min_kv:
+                continue
+            if max_kv is not None and entry.kv > max_kv:
+                continue
+            if min_max_current is not None and entry.max_current < min_max_current:
+                continue
+            if min_weight is not None and entry.weight_g < min_weight:
+                continue
+            if max_weight is not None and entry.weight_g > max_weight:
+                continue
+            results.append(entry)
+        return results

setuav_pythrust-0.1.0/pythrust/openmdao/__init__.py

@@ -0,0 +1,3 @@
+"""OpenMDAO integration components for PyThrust."""
+
+from .components import PropulsionComponent  # noqa: F401

setuav_pythrust-0.1.0/pythrust/openmdao/components.py

@@ -0,0 +1,103 @@
+"""OpenMDAO wrapper component for PyThrust propulsion solver."""
+
+from __future__ import annotations
+
+import math
+import openmdao.api as om
+
+from pythrust.propellers.database import PropellerEntry
+from pythrust.propulsion import (
+    BatterySpec,
+    MotorSpec,
+    PropellerSpec,
+    PropulsionSolver,
+    SystemSpec,
+)
+
+
+class PropulsionComponent(om.ExplicitComponent):
+    """OpenMDAO ExplicitComponent wrapping the PyThrust propulsion solver."""
+
+    def initialize(self) -> None:
+        self.options.declare(
+            'prop_entry',
+            types=PropellerEntry,
+            desc='PropellerEntry database object',
+        )
+
+    def setup(self) -> None:
+        # Inputs
+        self.add_input('kv_rpm_per_v', val=860.0, desc='Motor Kv [RPM/V]')
+        self.add_input('resistance_ohm', val=0.0258, desc='Motor winding resistance [ohm]')
+        self.add_input('no_load_current_a', val=1.3, desc='Motor no-load current [A]')
+        self.add_input('current_max_a', val=65.0, desc='Motor maximum current [A]')
+
+        self.add_input('voltage_v', val=14.8, desc='Battery pack voltage [V]')
+        self.add_input('discharge_efficiency', val=1.0, desc='Battery discharge efficiency')
+
+        self.add_input('resistance_system_ohm', val=0.095, desc='Lumped system transmission resistance [ohm]')
+        self.add_input('diameter_m', val=0.3302, desc='Propeller diameter [m]')
+        self.add_input('throttle', val=0.7, desc='Throttle fraction [0, 1]')
+
+        self.add_input('rho', val=1.225, desc='Air density [kg/m^3]')
+        self.add_input('airspeed_mps', val=0.0, desc='Flight airspeed [m/s]')
+
+        # Outputs
+        self.add_output('rpm', val=5000.0, desc='Equilibrium shaft speed [RPM]')
+        self.add_output('thrust_n', val=10.0, desc='Generated static/dynamic thrust [N]')
+        self.add_output('torque_nm', val=0.2, desc='Propeller shaft torque [N-m]')
+        self.add_output('battery_current_a', val=15.0, desc='Battery DC current draw [A]')
+        self.add_output('battery_power_w', val=220.0, desc='Battery power consumption [W]')
+        self.add_output('motor_current_a', val=15.0, desc='Motor winding current [A]')
+        self.add_output('motor_voltage_v', val=12.0, desc='Motor terminal voltage [V]')
+        self.add_output('is_feasible', val=1.0, desc='1.0 if feasible, 0.0 otherwise')
+
+        # Declare derivatives using finite-difference
+        self.declare_partials(of='*', wrt='*', method='fd')
+
+    def _get_specs(self, inputs: om.Vector) -> tuple[MotorSpec, BatterySpec, SystemSpec, PropellerSpec]:
+        motor = MotorSpec(
+            kv_rpm_per_v=float(inputs['kv_rpm_per_v'][0]),
+            resistance_ohm=float(inputs['resistance_ohm'][0]),
+            no_load_current_a=float(inputs['no_load_current_a'][0]),
+            current_max_a=float(inputs['current_max_a'][0]),
+        )
+        battery = BatterySpec(
+            voltage_v=float(inputs['voltage_v'][0]),
+            discharge_efficiency=float(inputs['discharge_efficiency'][0]),
+        )
+        system = SystemSpec(
+            resistance_ohm=float(inputs['resistance_system_ohm'][0]),
+        )
+        propeller = PropellerSpec(
+            diameter_m=float(inputs['diameter_m'][0]),
+        )
+        return motor, battery, system, propeller
+
+    def compute(self, inputs: om.Vector, outputs: om.Vector) -> None:
+        motor, battery, system, propeller = self._get_specs(inputs)
+        prop_entry = self.options['prop_entry']
+        throttle = float(inputs['throttle'][0])
+        rho = float(inputs['rho'][0])
+        airspeed_mps = float(inputs['airspeed_mps'][0])
+
+        solver = PropulsionSolver()
+        op = solver.solve_operating_point(
+            motor=motor,
+            battery=battery,
+            system=system,
+            propeller=propeller,
+            prop_entry=prop_entry,
+            rho=rho,
+            airspeed_mps=airspeed_mps,
+            throttle=throttle,
+        )
+
+        outputs['rpm'] = op.rpm
+        outputs['thrust_n'] = op.thrust_n
+        outputs['torque_nm'] = op.torque_nm
+        outputs['battery_current_a'] = op.battery_power_w / max(1e-6, battery.voltage_v)
+        outputs['battery_power_w'] = op.battery_power_w
+        outputs['motor_current_a'] = op.motor_current_a
+        outputs['motor_voltage_v'] = op.motor_voltage_v
+        outputs['is_feasible'] = 1.0 if op.is_feasible else 0.0

setuav_pythrust-0.1.0/pythrust/propellers/__init__.py

@@ -0,0 +1,8 @@
+"""Propeller database and lookup utilities."""
+
+from .database import (  # noqa: F401
+    PropellerDataPoint,
+    PropellerEntry,
+    PropellerMetadata,
+    PropellerDatabase,
+)