pystormflow 0.2.1__tar.gz → 0.3.0__tar.gz

pystormflow-0.3.0/.cargo/config.toml

@@ -0,0 +1,14 @@
+# Cargo configuration for pystormflow
+# These settings optimize the build for the user's specific CPU
+
+[build]
+# Use all available CPU cores for compilation
+jobs = -1
+
+[target.'cfg(target_arch = "x86_64")']
+# Enable native CPU optimizations (AVX, AVX2, etc. if available)
+rustflags = ["-C", "target-cpu=native"]
+
+[target.'cfg(target_arch = "aarch64")']
+# Enable native CPU optimizations for ARM64 (Apple Silicon, etc.)
+rustflags = ["-C", "target-cpu=native"]

pystormflow-0.3.0/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change log pystormflow
+
+This file contains an overview of the changes made to pystormflow, the Python interface to the Stormflow CFD solver. See the [Stormflow change log](../../stormflow/CHANGELOG.md) for changes to the solver, and the [Stormbird change log](../../stormbird/CHANGELOG.md) for changes to the actuator line model.
+
+## 0.3.0 - 2026-10-31
+### Breaking changes
+- Depends on the published versions of Stormflow 0.3.0 and Stormbird 0.12.0. There are no changes to the Python interface itself, but the setup files may need to be updated. See the [Stormflow change log](../../stormflow/CHANGELOG.md) for the changes to the solver, such as the new `boundary_condition_type` setting, and the [Stormbird change log](../../stormbird/CHANGELOG.md) for the changes to the actuator line model, such as the new dynamic stall model.
+
+### Other changes
+- Invalid input raises a Python exception rather than a panic, in the same way as in pystormbird: creating a `Simulation` from a setup string that can not be read raises a `ValueError`, and reading simulation results from file with `SimulationResult.from_json_file` or `SimulationResult.result_history_from_file` raises an `OSError` if the file can not be read, and a `ValueError` if the content can not be parsed. Settings that are found to be invalid when the simulation is built in Stormflow still give a panic.
+- New `section_models_internal_state` and `amount_of_stall` properties on the `SectionalForcesInput` class, as in pystormbird.
+- The source distribution is compiled with native CPU optimizations, through a new `.cargo/config.toml`, as in pystormbird.
+- The single rotor example is replaced by the new `rotor_sails/deybach_wind_tunnel` example, with one or two rotor sails in a wind tunnel, compared against the experiments by Deybach et al.
+
+## 0.2.1
+- Depends on Stormflow 0.2.1 and Stormbird 0.11.1. The main changes are new experimental limits on the lifting line correction in the actuator line model. See the [Stormflow change log](../../stormflow/CHANGELOG.md) and the [Stormbird change log](../../stormbird/CHANGELOG.md).
+
+## 0.2.0 - 2026-10-23
+### Breaking changes
+- Depends on Stormflow 0.2.0, Stormbird 0.11.0 and Stormath 0.4.0. The input format for the Stormbird models has changed in Stormbird 0.11.0, so setup files may need to be updated.
+- The `gyroscopic` property of the `SectionalForces` class is renamed to `gyroscopic_moment`, as the gyroscopic effect is now a pure moment in Stormbird. The `gyroscopic` property of the `IntegratedValues` class is unchanged.
+
+## 0.1.0
+The first version.

{pystormflow-0.2.1 → pystormflow-0.3.0}/Cargo.lock

@@ -919,7 +919,7 @@ dependencies = [
 
 [[package]]
 name = "pystormflow"
-version = "0.2.1"
+version = "0.3.0"
 dependencies = [
  "pyo3",
  "stormath",
@@ -1141,9 +1141,9 @@ dependencies = [
 
 [[package]]
 name = "stormbird"
-version = "0.11.1"
+version = "0.12.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fdfe6efffc14873788f547e5294bd9c881f24b84e033a2e02c1c2112fe303469"
+checksum = "58dd3ef773ce702fd01e8928fd09c122b71dfe0d611850d1c066cc775e212929"
 dependencies = [
  "serde",
  "serde_json",
@@ -1152,9 +1152,9 @@ dependencies = [
 
 [[package]]
 name = "stormflow"
-version = "0.2.1"
+version = "0.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e1631c825f7e6cd9329e27e45e4fb26e9481a2fe1e6c3bb737968190fa268e1e"
+checksum = "af8cf495075d36001dbac15413c67142fd30915a5ced8dc28a0eba76e8c8ba2c"
 dependencies = [
  "bytemuck",
  "clap",

{pystormflow-0.2.1 → pystormflow-0.3.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pystormflow"
-version = "0.2.1"
+version = "0.3.0"
 authors = ["Jarle Kramer <jarle.kramer@gmail.com>"]
 description = "Python interface to the Stormflow CFD solver."
 homepage = "https://github.com/NTNU-IMT/stormbird"
@@ -16,8 +16,8 @@ crate-type = ["cdylib"]
 [dependencies]
 pyo3 = "0.29.0"
 stormath = {version = "0.4.0", features=["single_precision"]}
-stormbird = { version="0.11.1", features=["single_precision"]}
-stormflow = { version="0.2.1" }
+stormbird = { version = "0.12.0", features = ["single_precision"] }
+stormflow = "0.3.0"
 
 [profile.release]
 opt-level = 3

{pystormflow-0.2.1 → pystormflow-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pystormflow
-Version: 0.2.1
+Version: 0.3.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)

{pystormflow-0.2.1 → pystormflow-0.3.0}/pyproject.toml

@@ -35,7 +35,8 @@ module-name = "pystormflow._native"
 python-source = "."
 features = ["pyo3/extension-module"]
 profile = "release"
-# The examples are not needed in the source distribution
+# The examples and the notes for the maintainer are not needed in the source distribution
 exclude = [
     { path = "examples/**/*", format = "sdist" },
+    { path = "maintainer_cheat_sheet.md", format = "sdist" },
 ]

{pystormflow-0.2.1 → pystormflow-0.3.0}/pystormflow/__init__.pyi

@@ -9,6 +9,10 @@ class SectionalForcesInput:
     @property
     def angles_of_attack(self) -> list[float]: ...
     @property
+    def section_models_internal_state(self) -> list[float]: ...
+    @property
+    def amount_of_stall(self) -> list[float]: ...
+    @property
     def acceleration(self) -> list[list[float]]: ...
     @property
     def rotation_velocity(self) -> list[float]: ...

{pystormflow-0.2.1 → pystormflow-0.3.0}/src/result_structs.rs

@@ -4,9 +4,12 @@
 
 use pyo3::prelude::*;
 use pyo3::types::PyType;
+use pyo3::exceptions::{PyIOError, PyValueError};
 
 use stormath::type_aliases::Float;
 
+use stormbird::error::Error;
+
 use stormbird::common_utils::results::simulation::SimulationResult as SimulationResultRust;
 use stormbird::common_utils::forces_and_moments::SectionalForces as SectionalForcesRust;
 use stormbird::common_utils::forces_and_moments::IntegratedValues as IntegratedValuesRust;
@@ -35,6 +38,20 @@ impl SectionalForcesInput {
         self.data.angles_of_attack.clone()
     }
 
+    #[getter]
+    /// The internal state given to the section model on each line element
+    pub fn section_models_internal_state(&self) -> Vec<Float> {
+        self.data.section_models_internal_state.clone()
+    }
+
+    #[getter]
+    /// The amount of stall used for the lift and drag on each line element. This is the dynamic
+    /// amount of stall for wings with a dynamic stall model, and zero for section models that are
+    /// not built on the foil model.
+    pub fn amount_of_stall(&self) -> Vec<Float> {
+        self.data.amount_of_stall.clone()
+    }
+
     #[getter]
     pub fn acceleration(&self) -> Vec<[Float; 3]> {
         self.data.acceleration.iter().map(|v| v.0).collect()
@@ -123,17 +140,21 @@ pub struct SimulationResult {
 #[pymethods]
 impl SimulationResult {
     #[classmethod]
-    pub fn from_json_file(_cls: &Bound<'_, PyType>, file_path: String) -> SimulationResult {
-        let data = SimulationResultRust::from_json(&file_path).unwrap();
-        
-        SimulationResult { data }
+    pub fn from_json_file(_cls: &Bound<'_, PyType>, file_path: String) -> PyResult<SimulationResult> {
+        let data = SimulationResultRust::from_json(&file_path).map_err(|e| {
+            Self::read_file_error(&file_path, e)
+        })?;
+
+        Ok(SimulationResult { data })
     }
     
     #[classmethod]
-    pub fn result_history_from_file(_cls: &Bound<'_, PyType>, file_path: String) -> Vec<SimulationResult> {
-        let rust_vector = SimulationResultRust::result_history_from_file(&file_path).unwrap();
+    pub fn result_history_from_file(_cls: &Bound<'_, PyType>, file_path: String) -> PyResult<Vec<SimulationResult>> {
+        let rust_vector = SimulationResultRust::result_history_from_file(&file_path).map_err(|e| {
+            Self::read_file_error(&file_path, e)
+        })?;
 
-        rust_vector.iter().map(|v| SimulationResult { data: v.clone() }).collect()
+        Ok(rust_vector.iter().map(|v| SimulationResult { data: v.clone() }).collect())
     }
 
     #[getter]
@@ -209,3 +230,16 @@ impl SimulationResult {
         self.data.write_to_file(&file_path).expect("Error from write to file")
     }
 }
+
+impl SimulationResult {
+    /// Converts an error from reading a result file to a Python error. Errors from reading the
+    /// file become an OSError, while errors from parsing the content become a ValueError.
+    fn read_file_error(file_path: &str, error: Error) -> PyErr {
+        let message = format!("Failed to read simulation result from file {}: {}", file_path, error);
+
+        match error {
+            Error::IoError(_) => PyIOError::new_err(message),
+            _ => PyValueError::new_err(message),
+        }
+    }
+}

{pystormflow-0.2.1 → pystormflow-0.3.0}/src/simulation.rs

@@ -1,6 +1,7 @@
 
 use pyo3::prelude::*;
 use pyo3::types::PyBytes;
+use pyo3::exceptions::PyValueError;
 
 use stormath::type_aliases::Float;
 use stormflow::simulation::Simulation as SimulationRust;
@@ -15,10 +16,12 @@ pub struct Simulation {
 #[pymethods]
 impl Simulation {
     #[new]
-    pub fn new(setup_string: String) -> Self {
-        Self {
-            data: SimulationRust::new_from_string(&setup_string).unwrap()
-        }
+    pub fn new(setup_string: String) -> PyResult<Self> {
+        let data = SimulationRust::new_from_string(&setup_string).map_err(|e| {
+            PyValueError::new_err(format!("Failed to create simulation from string: {}", e))
+        })?;
+
+        Ok(Self { data })
     }
 
     pub fn time_step_from_courant_number(&self, courant_number: Float) -> Float {

pystormflow-0.2.1/CHANGELOG.md

@@ -1,14 +0,0 @@
-# Change log pystormflow
-
-This file contains an overview of the changes made to pystormflow, the Python interface to the Stormflow CFD solver. See the [Stormflow change log](../../stormflow/CHANGELOG.md) for changes to the solver, and the [Stormbird change log](../../stormbird/CHANGELOG.md) for changes to the actuator line model.
-
-## 0.2.1
-- Depends on Stormflow 0.2.1 and Stormbird 0.11.1. The main changes are new experimental limits on the lifting line correction in the actuator line model. See the [Stormflow change log](../../stormflow/CHANGELOG.md) and the [Stormbird change log](../../stormbird/CHANGELOG.md).
-
-## 0.2.0 - 2026-10-23
-### Breaking changes
-- Depends on Stormflow 0.2.0, Stormbird 0.11.0 and Stormath 0.4.0. The input format for the Stormbird models has changed in Stormbird 0.11.0, so setup files may need to be updated.
-- The `gyroscopic` property of the `SectionalForces` class is renamed to `gyroscopic_moment`, as the gyroscopic effect is now a pure moment in Stormbird. The `gyroscopic` property of the `IntegratedValues` class is unchanged.
-
-## 0.1.0
-The first version.