turbigen 2.0.0__tar.gz → 2.1.0__tar.gz

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

@@ -1,6 +1,7 @@
 Metadata-Version: 2.1
 Name: turbigen
-Version: 2.0.0
+Version: 2.1.0
+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.1.0/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.1.0/bin/noquit.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+# 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.1.0/doc/changelog.rst

@@ -0,0 +1,222 @@
+Changelog
+=========
+
+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.1.0}/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.1.0}/doc/index.rst

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

turbigen-2.1.0/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

{turbigen-2.0.0 → turbigen-2.1.0}/doc/quickstart.rst

@@ -18,6 +18,7 @@ avoid interference, we recommend the `uv` `package manager <https://docs.astral.
 .. code-block:: console
 
    $ curl -LsSf https://astral.sh/uv/install.sh | sh
+   $ source $HOME/.local/bin/env
    $ uv tool install turbigen
 
 These commands will install `uv`, then use it to install :program:`turbigen` into an
@@ -41,7 +42,7 @@ To run a case, use,
     $ turbigen INPUT_YAML
 
 where `INPUT_YAML` is a yaml configuration file. Specimen configuration files
-are provided in the :doc:`examples/index` directory. 
+are provided in the :doc:`examples/index` directory.
 Results will be logged to the screen and saved to a file in the working
 directory specified in the input file.
 
@@ -52,4 +53,3 @@ run:
 .. code-block:: console
 
     $ turbigen --help
-

turbigen-2.1.0/doc/usage.rst

@@ -0,0 +1,9 @@
+.. _usage:
+
+Command-line options
+====================
+
+.. argparse::
+   :module: turbigen.main
+   :func: _make_argparser
+   :prog: turbigen

{turbigen-2.0.0 → turbigen-2.1.0}/examples/axial_turbine.yaml

@@ -53,8 +53,6 @@ blades:
       tip: 0.01
 
 # Circulation coefficient to set blade loadings
-# Note an initial guess that is iteratively updated
-# to reach a target diffusing factor (configured below)
 nblade:
   - Co: 0.6
   - Co: 0.6

{turbigen-2.0.0 → turbigen-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "turbigen"
-version = "2.0.0"
+version = "2.1.0"
 requires-python = ">=3.11"
 license = {text = "GPL-3.0-or-later"}
 authors = [
@@ -21,6 +21,8 @@ dependencies = [
     'numpy-stl~=3.2.0',
     'metis~=0.2a5',
 ]
+description = "Framework for turbomachinery design and computational fluid dynamics simulation"
+readme = "README.md"
 keywords = ["turbomachinery", "computational fluid dynamics", "compressor", "turbine"]
 
 [project.optional-dependencies]
@@ -43,6 +45,7 @@ parallel = [
 
 [project.urls]
 Homepage = "https://turbigen.org"
+Repository = "https://gitlab.developers.cam.ac.uk/jb753/turbigen"
 
 [project.scripts]
 turbigen = "turbigen.main:main"
@@ -62,7 +65,7 @@ archs = ["x86_64"]
 managed = false
 
 [tool.bumpversion]
-current_version = "2.0.0"
+current_version = "2.1.0"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{turbigen-2.0.0 → turbigen-2.1.0}/src/turbigen/base.py

@@ -811,10 +811,6 @@ class Kinematics:
         # Interpolate the data
         Cf = C.to_unstructured()
 
-        print(f"Theta pitch={pitch}")
-        print(f"Unstr theta lim = {np.max(Cf.t), np.min(Cf.t)}")
-        print(f"Struct theta lim = {np.max(Cs.t), np.min(Cs.t)}")
-
         if np.ptp(Cf.x) > np.ptp(Cf.r):
             xi = np.stack((Cf.x, Cf.t), axis=-1)
             xo = np.stack((Cs.x, Cs.t), axis=-1)

{turbigen-2.0.0 → turbigen-2.1.0}/src/turbigen/config2.py

@@ -1,6 +1,7 @@
 """Initial thoughts on an improved config class."""
 
 import dataclasses
+from copy import deepcopy
 import numpy as np
 import pickle
 import sys
@@ -16,12 +17,12 @@ import turbigen.grid
 import turbigen.post
 import turbigen.geometry
 import turbigen.yaml
-import importlib
 import turbigen.annulus
 import turbigen.inlet
 import turbigen.mesh
 import turbigen.blade
 import turbigen.nblade
+import turbigen.job
 from turbigen import util
 from typing import List
 from matplotlib.backends.backend_pdf import PdfPages
@@ -75,8 +76,6 @@ class TurbigenConfig:
     grid: turbigen.grid.Grid = None
     guess: turbigen.grid.Grid = None
 
-    skip: bool = False
-
     cut_offset: float = 0.02
     """Spacing of CFD solution cuts away from blade edges, as fraction of chord."""
 
@@ -84,6 +83,19 @@ class TurbigenConfig:
 
     post_process: list = dataclasses.field(default_factory=list)
 
+    job: turbigen.job.BaseJob = None
+    """Settings for queue job submission."""
+
+    _basename: str = "config.yaml"
+
+    def copy(self):
+        """Return a copy of the configuration."""
+        return deepcopy(self)
+
+    @property
+    def fname(self):
+        return self.workdir / self._basename
+
     Re_surf: float = None
     """Set viscosity using a Reynolds number."""
 
@@ -91,12 +103,15 @@ class TurbigenConfig:
     def nrow(self):
         return len(self.blades)
 
-    def save(self, fname: str = "config.yaml"):
+    def save(self, fname=None):
         """Save the configuration to a YAML file inside workdir.
 
         The working directory will be created if it does not exist.
         """
 
+        if fname is None:
+            fname = self.fname
+
         if not self.workdir.exists():
             self.workdir.mkdir(parents=True)
 
@@ -119,10 +134,10 @@ class TurbigenConfig:
         logger.debug(f"Saving configuration to {conf_fname}")
         try:
             turbigen.yaml.write_yaml(data, conf_fname)
-        except Exception as e:
+        except Exception:
             logger.error(f"Failed to save configuration to {conf_fname}")
-            print(data)
-            quit()
+            logger.error(data)
+            sys.exit(1)
 
         return conf_fname
 
@@ -164,6 +179,13 @@ class TurbigenConfig:
         if not self.mean_line_actual:
             del data["mean_line_actual"]
 
+        # If no job, remove it
+        if not self.job:
+            del data["job"]
+        else:
+            # Add the job type to the dictionary
+            data["job"]["type"] = util.camel_to_snake(self.job.__class__.__name__)
+
         # If no iterators, remove it
         if not self.iterate:
             del data["iterate"]
@@ -182,6 +204,12 @@ class TurbigenConfig:
                     post.__class__.__name__
                 )
 
+        # Remove keys starting with '_'
+        # These are not part of the configuration
+        for k in list(data.keys()):
+            if k.startswith("_"):
+                data.pop(k)
+
         return data
 
     def find_plugins(self):
@@ -311,6 +339,13 @@ class TurbigenConfig:
         else:
             self.post_process = []
 
+        # Configure job submission if present
+        if j := self.job:
+            if not (type := j.pop("type")):
+                raise Exception("Missing type key in job settings")
+            cls = util.get_subclass_by_name(turbigen.job.BaseJob, type)
+            self.job = cls(**j)
+
         # Add some default post processors
         defaults = [
             turbigen.post.SurfaceDistribution(),
@@ -674,7 +709,8 @@ class TurbigenConfig:
 
         # Add efficiency row
         table_pad.append(
-            f"Efficiency/%: eta_tt={self.mean_line.actual.eta_tt * 100.0:.1f}, eta_ts={self.mean_line.actual.eta_ts * 100:.1f}"
+            f"Efficiency/%: eta_tt={self.mean_line.actual.eta_tt * 100.0:.1f}, "
+            f"eta_ts={self.mean_line.actual.eta_ts * 100:.1f}"
         )
 
         # Join the lines
@@ -689,7 +725,7 @@ class TurbigenConfig:
         self.inlet.mu = mu
         self.mean_line.nominal.mu = mu
 
-    def design_and_run(self):
+    def design_and_run(self, skip):
         """Run a configuration file through the CFD solver.
 
         This will do the following:
@@ -729,7 +765,7 @@ class TurbigenConfig:
         # (3) Normal operation: mesh and run the CFD solver
 
         # Generate mesh in cases (2) and (3)
-        if not (self.skip and self.grid):
+        if not (skip and self.grid):
             logger.info("Generating mesh...")
             self.setup_mesh()  # Overwrite self.grid with a new mesh
             self.apply_guess()
@@ -738,7 +774,7 @@ class TurbigenConfig:
             logger.info("Skipping and already have a guess, not generating mesh...")
 
         # In case (3), run the CFD solver
-        if not self.skip:
+        if not skip:
             self.run_solver()
         # Case (1), load convergence history
         # A no-op in Case (2)