turbigen 2.0.0__tar.gz → 2.2.1__tar.gz

{turbigen-2.0.0 → turbigen-2.2.1}/.gitlab-ci.yml

@@ -65,6 +65,7 @@ doc:
       - doc/_build
   script:
     - python doc/generate_examples.py
+    - python doc/generate_meanline.py
     - sphinx-build -W doc doc/_build
 
 pages:

{turbigen-2.0.0 → turbigen-2.2.1}/PKG-INFO

@@ -1,6 +1,7 @@
 Metadata-Version: 2.1
 Name: turbigen
-Version: 2.0.0
+Version: 2.2.1
+Summary: Framework for turbomachinery design and computational fluid dynamics simulation
 Keywords: turbomachinery,computational fluid dynamics,compressor,turbine
 Author-Email: James Brind <jb753@cam.ac.uk>
 License: GPL-3.0-or-later
@@ -8,6 +9,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: POSIX :: Linux
 Project-URL: Homepage, https://turbigen.org
+Project-URL: Repository, https://gitlab.developers.cam.ac.uk/jb753/turbigen
 Requires-Python: >=3.11
 Requires-Dist: CoolProp~=6.7.0
 Requires-Dist: matplotlib~=3.10.0
@@ -31,4 +33,12 @@ Requires-Dist: twine; extra == "dev"
 Requires-Dist: bump-my-version; extra == "dev"
 Provides-Extra: parallel
 Requires-Dist: mpi4py~=3.1.6; extra == "parallel"
+Description-Content-Type: text/markdown
 
+# turbigen
+
+**James Brind, Whittle Laboratory, University of Cambridge**
+
+turbigen is a general turbomachinery design system based on automated computational fluid dynamics simulations. See the user manual at:
+
+[User Manual](https://turbigen.org)

turbigen-2.2.1/README.md

@@ -0,0 +1,7 @@
+# turbigen
+
+**James Brind, Whittle Laboratory, University of Cambridge**
+
+turbigen is a general turbomachinery design system based on automated computational fluid dynamics simulations. See the user manual at:
+
+[User Manual](https://turbigen.org)

turbigen-2.2.1/bin/noquit.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+exit 0
+# noquit DIR
+# Exit 1 if any 'quit()' or print statements are found in any files under DIR
+! find src/turbigen -name '*.py' ! -name 'convert_ts3_to_ts4_native.py' -exec grep -nH '^ *quit()\|^ *print(\|^ *np.empty(' {} +

turbigen-2.2.1/doc/changelog.rst

@@ -0,0 +1,237 @@
+Changelog
+=========
+
+v2.2.0
+^^^^^^
+
+* Allow partial configuration files, exiting at first blank required key
+* Faster compiler flags for Fortran
+* Turbostream solvers with new base class
+* Generate meanline documentation from the docstrings
+* Catch post-processing errors and continue
+* Submit jobs to a local queue, implement worker script
+* Check for nans in ember
+* Allow invocation with `python -m turbigen`
+* Implement design space sampling
+* Bug fix for repeating stage iterator if spanwise points unequal
+* General tidying up
+
+v2.1.0
+^^^^^^
+
+* Add generic job configuration, and implement SLURM submission
+* Add description and README to PyPI
+* Add changelog, license, command-line options to docs
+* Clean up some dead code and unused imports
+
+v2.0.0
+^^^^^^
+
+* Comprehensive internal refactoring of the code for better maintainability
+* Finish the built-in CFD solver
+* Plugin system now uses abstract base classes and reads all modules from a directory, rather than importing a single file by path
+* AutoGrid server supports parallel workers, more settings, better robustnees checks
+* Automate running examples to include results in docs
+* Numerous bug fixes, improved error messages, etc.
+* Use meson to compile the Fortran during installation, upload built linux
+  wheels to PyPI -- allows pip install
+
+v1.10.1
+^^^^^^^
+
+* Bugfix for AutoGrid server not reading the delete switch
+* Bugfix for scalar mean-line iterate variables
+
+v1.10.0
+^^^^^^^
+
+* Use rotation-corrected static pressure to find stagnation points
+* Add mixed-flow mean-line with mixed and pure radial examples
+* Script to read polynomial coefficients and evaluate a previously-fitted design space
+* Allow unbladed first row in H-mesh
+* Add a syntax check for TS4 body force template
+* Generalise to multi-stage machines
+* Wrap the incidence angle with respect to camber angle
+* Bugfix for TS4 throttle config
+* Add -m command-line switch to debug the mean-line
+* Take CFD inlet pitch angle from the mesh, not mean-line design
+* Implement command-line options for AutoGrid server
+* Bugfix to allow incidence correction on only one section
+* Reduce LE recamber when incidence is close to tolerance
+
+
+v1.9.1
+^^^^^^
+
+* Add retry for AutoGrid connections
+* Use unstructured spanwise cuts to calculate incidence
+* More robust tip H-meshing
+* Incidence correction bugfix for unbladed cases
+* Only reduce proportional part of PID controller gain on restart
+* Clean up the hypercube running code
+* Turbostream 3 SA helicity correction
+* Better Turbostream 4 application variable defaults
+* Use turbulent viscosity from old solution on restart
+* Fix error in docs iterate config
+
+
+v1.9.0
+^^^^^^
+
+* Add post-processing functions for unstructured cuts at constant span fraction
+* Put rotational speeds in AutoGrid geomTurbo file when OH meshing
+* Support TS3 cooling patches
+* Method to allow trimming of grid blocks in pre-processing
+* Compatability fixes for numpy 2 and pin dependency versions
+* Add TS4 halo_implementation setting
+* Fix bug with zero wall distance on non-matching patches
+* Check patch indices are consistent with block size before writing TS3 input
+
+
+v1.8.0
+^^^^^^
+
+* Fit blade sections to coordinates read from a file
+* Overhaul post processing with separate functions for all plots
+* Rewrite LE incidence calculation to work generally for axial and radial
+* Allow off-design operation with rpm_adjust and mass_adjust settings
+* Setting for inviscid boudary condition on zero-radius rod
+* When running installed turbomachine, reuse installed initial guess
+* Allow install function to return inverse design variables to mean line
+* Add rounded trailing edge and fillet options to autogrid meshing
+* Check for membership of the turbostream group before running TS3
+* Error if we cannot locate the specified TS4 throttle tag
+* Allow arbitrary setting of perfect gas internal energy datum
+* Handle errors in cluster jobs and hold the node for debugging
+* Allow unbladed rows in OH meshes
+* Close off the tip of unshrouded rotor blades in STL export
+* Make the coordinate check optional for debugging
+* Fix bounds error on annulus interpolation due to floating point error
+
+
+v1.7.0
+^^^^^^
+
+* Fix bug with noisy TS4 console logging
+* Allow labels on TS4 point probes with different file names
+* Implement unsteady boundary conditions into pre-processing framework
+* Add tutorial to documentation
+
+v1.6.1
+^^^^^^
+
+* Fix bug where zero-valued configuration options are not written out
+
+v1.6.0
+^^^^^^
+
+* General grid refinement by subdivision of cells
+* Allow halting iterations by creating a stopit file in working directory
+* Check for two-phase flow at the end of the calculation
+* Incidence correction for splitters
+* Improve robustness and simplify AutoGrid meshing script
+* Use improved clustering functions for H-meshing
+* Plot pressure distributions
+* Implement loading mean-line, annulus, and installation modules from file
+* Allow arbitrary external monitoring scripts in TS4 simulations (e.g. to change body force)
+* Configuration option for maximum H-mesh free stream skew
+* Fix AutoGrid patch matching bug
+* Fix bug with TS4 cfl_ramp_en not set
+
+
+v1.5.1
+^^^^^^
+
+* Minor corrections for open release
+
+v1.5.0
+^^^^^^
+
+
+* General tidying up of the code
+* Incidence correction only when mass flow is on target
+* Rework configuration and command-line options
+* Improve documentation
+* Automatic numbering of working directories
+
+v1.4.0
+^^^^^^
+
+* Implement sweep by changing meridional locations of LE/TE
+* Add splitter capability
+* Allow preconditioning in TS4
+* Yet more AutoGrid meshing options
+* Record Exceptions in the turbigen log file, in addition to STDERR.
+
+v1.3.4
+^^^^^^
+
+* More robust unstructured cutting by Marching Cubes algorithm.
+* Allow prescribing body force in TS 4.2.82
+* Find stagnation point by sign change of surface velocity
+* Implement NaN check for TS4
+* Write out a design space fit to json for web interface
+* More AutoGrid options including untwist outlet
+
+v1.3.3
+^^^^^^
+
+* Update radial turbine to set stator LE diameter ratio
+
+v1.3.2
+^^^^^^
+
+* Allow custom TS3->TS4 conversion pipelines
+* True Taylor camberline (quartic in chi, not tan chi)
+* Generalise incidence correction to radial inflows and outflows
+
+v1.3.1
+^^^^^^
+
+* Add rotor-only fan mean line
+
+v1.3.0
+^^^^^^
+
+* Improved H-mesh tip-gap grid
+* Add installation effects module
+* Add write coordinates solver
+* Allow running in parallel
+
+v1.2.0
+^^^^^^
+
+* Implement polynomial design-space fitting.
+* Add option to run a hypercube of designs.
+* Improve characteristic running.
+* Fix bugs with mixing of supersonic flows and area signage.
+* Fix bug with setting shroud rpm.
+* Generalise to select a type of thickness distribution.
+* Clean up the log file outputs.
+* Skew H-mesh in flow direction outside of blade rows.
+* Added unstructured cutting for post-processing the mixed-out flow.
+* Added throttling options to target mass flow for TS3 and TS4.
+* Added radial turbine mean-line design functions and example.
+* Internal rewrite of data structures to be CFD-solver agnostic.
+* ... plus other miscellaneous enhancements and tidying.
+
+v1.1.0
+^^^^^^
+
+* Added H-meshing option, with pinched tips.
+* `Config` object for programmatic creation and validation of input files.
+* Automated post processing to get a `MeanLine` object from mixed-out CFD cuts.
+* Use inlet velocity as reference for compressor circulation coefficient.
+* Mixed-out averaging generalised for any meridional cut (not just constant axial coordinate).
+* Iteration to correct for incidence, deviation, and mean-line guesses.
+* Options to set blade number directly or Lieblein diffusion factor.
+* Running characteristics for compressor designs.
+* Generate real gas tables for TS4 on demand.
+* Let TS3 grid object use arbitrary equation of state for post-processing.
+* Post-processing TS4 simulations by reading the flow field into a structured TS3 grid.
+* Config file options to submit a job to the SLURM queue.
+
+v1.0.0
+^^^^^^
+
+* First Whittle Laboratory internal release.

{turbigen-2.0.0 → turbigen-2.2.1}/doc/conf.py

@@ -13,6 +13,7 @@
 import os
 import sys
 import turbigen
+import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -103,6 +104,18 @@ mathjax3_config = {
 bibtex_bibfiles = ["refs.bib"]
 bibtex_reference_style = "author_year"
 
+# Update copyright year
+current_year = datetime.datetime.now().year
+
+# Optional: if you want to support a range like 2020–2025
+start_year = 2023
+if current_year == start_year:
+    copyright_year = str(start_year)
+else:
+    copyright_year = f"{start_year}–{current_year}"
+
+# Define the replacement
 rst_epilog = f"""
 .. |ProjectVersion| replace:: {release}
+.. |copyright_year| replace:: {copyright_year}
 """

{turbigen-2.0.0 → turbigen-2.2.1}/doc/generate_examples.py

@@ -5,8 +5,6 @@ import re
 import shutil
 import subprocess
 from pathlib import Path
-import logging
-import sys
 import yaml
 
 INPUT_DIR = "examples"
@@ -40,7 +38,7 @@ def run_example(input_yaml):
     # Attempt to parse the title
     try:
         title = comments[0].split("#")[-1].strip()
-    except:
+    except Exception:
         title = "Example"
 
     # Parse workdir from the log

turbigen-2.2.1/doc/generate_meanline.py

@@ -0,0 +1,54 @@
+"""Make documentation for an abstract base class and subclasses."""
+
+import turbigen.meanline
+from turbigen import util
+import inspect
+
+
+def generate_subclass(cls, fname):
+    rst_str = ""
+
+    # Base class first
+    doc = inspect.getdoc(cls).split("xxx")
+    rst_str += doc[0]
+
+    # Now subclasses
+    for subclass in cls.__subclasses__():
+        rst_str += "\n\n"
+        rst_str += inspect.getdoc(subclass)
+        rst_str += "\n\n"
+
+        cls_name = util.camel_to_snake(subclass.__name__)
+        try:
+            rst_str += format_yaml_snippet(subclass._design_vars, cls_name)
+        except AttributeError:
+            pass
+
+    if len(doc) > 1:
+        rst_str += doc[1]
+
+    # Write the rst string to a file
+    with open(f"doc/{fname}.rst", "w") as f:
+        f.write(rst_str)
+
+
+def format_yaml_snippet(data_dict, title):
+    lines = ["mean_line:"]
+    lines.append(f"  type: {title}")
+    for name, (desc, shape, default) in data_dict.items():
+        shape_str = ", " + str(shape) + " vector" if shape else ""
+        default_str = "" if default is None else str(default)
+        lines.append(f"  # {desc}{shape_str}")
+        lines.append(f"  {name}: {default_str}")
+
+    # Apply rst indentation
+    lines = ["    " + line for line in lines]
+    lines.insert(0, ".. code-block:: yaml\n")
+
+    blurb = "To use this architecture, add the following snippet in your configuration file:\n\n"
+
+    return blurb + "\n".join(lines)
+
+
+if __name__ == "__main__":
+    print(generate_subclass(turbigen.meanline.MeanLineDesigner, "meanline"))

turbigen-2.2.1/doc/generate_solver.py

@@ -0,0 +1,93 @@
+"""Make documentation for an abstract base class and subclasses."""
+
+import turbigen.solvers.base
+import turbigen.solvers.emb
+from turbigen import util
+import inspect
+import dataclasses
+
+
+def generate_subclass(cls, fname):
+    rst_str = ""
+
+    # Base class first
+    doc = inspect.getdoc(cls).split("xxx")
+    rst_str += doc[0]
+
+    # Now subclasses
+    for subclass in cls.__subclasses__():
+        print(subclass)
+        rst_str += "\n\n"
+        rst_str += inspect.getdoc(subclass)
+        rst_str += "\n\n"
+
+        cls_name = util.camel_to_snake(subclass.__name__)
+        rst_str += generate_rst_table(subclass)
+
+    if len(doc) > 1:
+        rst_str += doc[1]
+
+    # Write the rst string to a file
+    with open(f"doc/{fname}.rst", "w") as f:
+        f.write(rst_str)
+
+
+def generate_rst_table(cls):
+    # Extract all dataclass fields
+    fields = dataclasses.fields(cls)
+    names = [f.name for f in fields]
+
+    # Extract docstrings from the class source
+    source_lines = inspect.getsourcelines(cls)[0]
+    doc_map = {}
+    current_field = None
+
+    for line in source_lines:
+        line = line.strip()
+        if line.startswith("#") or not line:
+            continue
+        elif ":" in line and "=" in line:
+            name = line.split(":")[0].strip()
+            if name in names:
+                current_field = name
+                print(f"Found field: {name}")
+        elif '"""' in line or "'''" in line:
+            doc = line.strip(' """\'')
+            if current_field:
+                print(f"Found docstring: {doc}")
+                doc_map[current_field] = doc
+                current_field = None
+
+    # RST table header
+    lines = [
+        ".. list-table:: Parameters",
+        "   :widths: 20 15 15 50",
+        "   :header-rows: 1",
+        "",
+        "   * - Name",
+        "     - Type",
+        "     - Default",
+        "     - Description",
+    ]
+
+    for f in fields:
+        name = f.name
+        type_ = f.type.__name__ if hasattr(f.type, "__name__") else str(f.type)
+        default = f.default if f.default != dataclasses.MISSING else "Required"
+        doc = doc_map.get(name, "")
+        try:
+            getattr(turbigen.solvers.base.BaseSolver, name)
+            print(f"Skipping field: {name}")
+            continue
+        except AttributeError:
+            pass
+        lines.append(f"   * - ``{name}``")
+        lines.append(f"     - ``{type_}``")
+        lines.append(f"     - ``{default}``")
+        lines.append(f"     - {doc}")
+
+    return "\n".join(lines)
+
+
+if __name__ == "__main__":
+    generate_subclass(turbigen.solvers.base.BaseSolver, "solver")

{turbigen-2.0.0 → turbigen-2.2.1}/doc/index.rst

@@ -16,5 +16,9 @@ User manual
 
    quickstart
    nomenclature
+   usage
+   meanline
+   solver
    examples/index
-
+   changelog
+   license

turbigen-2.2.1/doc/license.rst

@@ -0,0 +1,19 @@
+License
+=======
+
+Copyright (c) |copyright_year| James Brind
+
+:program:`turbigen` is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program. If not, see <https://www.gnu.org/licenses/>.
+
+
+.. program-output:: cat ../COPYING