tankoh2 2.7.1__tar.gz

tankoh2-2.7.1/LICENSE.md

@@ -0,0 +1,13 @@
+<!--
+SPDX-FileCopyrightText: 2020 German Aerospace Center (DLR)
+SPDX-License-Identifier: MIT
+-->
+
+
+## License
+
+Copyright © 2020 German Aerospace Center (DLR)
+
+This work is licensed under the [MIT](LICENSES/MIT.txt) license.
+
+> **Hint:** We provided the copyright and license information in accordance to the [REUSE Specification 3.0](https://reuse.software/spec/).

tankoh2-2.7.1/LICENSES/MIT.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 sfreund-DLR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tankoh2-2.7.1/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.3
+Name: tankoh2
+Version: 2.7.1
+Summary: Design and optimization of H2 tanks for high pressure applications and cryogenic hydrogen storage
+License: MIT
+Keywords: lh2 tank,winding,hydrogen,storage
+Author: Sebastian Freund
+Author-email: sebastian.freund@dlr.de>
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: CoolProp
+Requires-Dist: defusedxml
+Requires-Dist: matplotlib
+Requires-Dist: numpy (<2)
+Requires-Dist: openturns
+Requires-Dist: pandas
+Requires-Dist: ruamel.yaml
+Requires-Dist: scipy
+Project-URL: Changelog, https://gitlab.dlr.de/sy-stm/software/tankoh2/-/blob/master/changelog.md
+Project-URL: Documentation, https://sy-stm.pages.gitlab.dlr.de/software/tankoh2/
+Project-URL: Homepage, https://gitlab.dlr.de/sy-stm/software//tankoh2
+Project-URL: Repository, https://gitlab.com/DLR-SY/tank/tankoh2
+Description-Content-Type: text/markdown
+
+# tankoh2
+
+[![pipeline status](https://gitlab.com/DLR-SY/tank/tankoh2/badges/master/pipeline.svg)](https://gitlab.com/DLR-SY/tank/tankoh2/-/commits/master)
+[![coverage report](https://gitlab.com/DLR-SY/tank/tankoh2/badges/master/coverage.svg)](https://gitlab.com/DLR-SY/tank/tankoh2/-/commits/master)
+[![Latest Release](https://gitlab.com/DLR-SY/tank/tankoh2/-/badges/release.svg)](https://gitlab.com/DLR-SY/tank/tankoh2/-/releases)
+
+
+Design and optimization of H2 tanks.
+
+For metal structures, tankoh2 is a standalone pre-design tool.
+For CFRP structures, a detailed winding optimization is performed.
+The winding simulation is carried out by [µChain](https://www.mefex.de/software/)
+
+## Features
+
+- Material/layup read/write
+- Define requirements for cryogenic or high-pressure hydrogen storage
+- Create dome (spherical, isotensoid, torisspherical or conical) and liner from cylindrical length and radius or using a dome contour
+- Setup of a vessel model
+- Optimization of each layer with respect to minimizing puck fibre failure, bending loads, and maintaining a good contour
+- Create and run DOE with support of DLR tools (delismm, fa_pyutils)
+- Routines for the improvement of the FEM model generatred by Abaqus CAE
+- Planned features:
+  - Global optimization of
+    - All angles of helical layers
+    - All hoop layer shifts
+    - Target: mass minimization
+    - Constraint: puck fibre failure
+  - Improved DOE: Liner and fitting adjustment w.r.t. vessel geometry
+  - Abaqus: introduction of the abaqus solver at the end of the optimization process
+
+## Documentation
+Here is the full [Documentation](https://dlr-sy.gitlab.io/tank/tankoh2/)
+
+## Installation
+
+### Installation for users
+Coming soon: installation via pypi using `pip install tankoh2`
+
+When tankoh2 is installed, please follow the steps in [Settings File](#settings-file).
+
+### Installation from source
+- Get tankoh2 from
+  > https://gitlab.com/DLR-SY/tank/tankoh2.git
+- Install python 3.10 (On the Windows Installer, check the advanced option to add Python to your path and to install pip)
+- Install poetry
+  > pip install poetry
+- Install requirements for the project
+  > cd <path_to_tankoh2>
+  > poetry install
+- When tankoh2 is installed, please follow the steps in [Settings File](#settings-file).
+
+### For winding: Path to µChain
+
+Add an environment variable named MYCROPYCHAINPATH
+and set its value to the path of your [µChain](https://www.mefex.de/software/) installation.
+
+Old Method, will be deprecated soon: Alternatively, in the folder `/src/tankoh2/`, create a file `settings.json`
+and include the path here.
+
+```
+{
+  "mycropychainPath": "<path_to_muChain>"
+}
+```
+
+### Activate the environment
+
+This needs to be done whenever you want to use tankoh2.
+First, navigate into tankoh2's source directory.
+
+```
+cd <path_to_tankoh2>/src
+```
+
+Then, before running tankoh2, you need to activate the python environment created by poetry during the installation. Alternatively replace 'python' in the commands with 'poetry run'.
+
+```
+poetry shell
+```
+
+### Test the installation
+
+```
+python -m tankoh2 --help
+```
+
+You can perform a standalone test for metal tanks
+
+```
+python -m tankoh2 --materialName alu2219 --windingOrMetal metal --domeType circle
+```
+
+### Developers
+- Follow the steps [Installation from source](#installation-from-source) above
+- Install all dev dependencies and test dependencies listed in ``pyproject.toml``
+
+#### Pre-Commit Hooks
+
+Developers may also install the pre-commit hook.
+
+**Precommit**
+1. If not installed: install the pre-commit
+   > pip install pre-commit
+2. In the tankoh2 folder
+   > pre-commit install
+
+This enables the pre-commit hooks defined in _.pre-commit-config.yaml_
+and eases your commits and successful pipline runs. You can test pre-commit by running
+> pre-commit run
+
+### Requirements
+
+see **tool.poetry.dependencies** section in [pyproject.toml](pyproject.toml)
+
+FreeCAD is required for conical domes
+
+## Usage
+A full list the available parameters is created with
+
+```
+python -m tankoh2 --help
+```
+
+### Winding
+
+For winding mode, a valid µWind license is required!
+Run the following, to start a winding optimization.
+
+```
+python -m tankoh2
+```
+
+### Metal
+
+A design run for metal structures can be run by
+
+```
+python -m tankoh2 --materialName alu2219 --windingOrMetal metal --domeType circle
+```
+
+### Config Files:
+It's easiest to write design config files in .yaml format to define any parameters for the winding or metal simulation. Using config files, it's possible to reproduce and modify runs.
+Config files need to be put in the folder tankoh2/designs and are used via the option --configFile [nameOfFile.yaml]. For example:
+
+```
+python -m tankoh2 --configFile 700bar_example.yaml
+```
+
+Any non-default parameters can be defined in parameter:value pairs. All possible parameters with descriptions can be seen in defaults.yaml and in the documentation. Config files can also recursively include other configFiles as parameters, whose parameters can be overwritten.
+The parameters which were used in each run are also saved in .yaml format in the run directory. These directories are located under tankoh2/tmp by default.
+
+Parameters given in config files are overwritten by parameters supplied explicitly via options.
+
+```
+python -m tankoh2 --configFile 700bar_example.yaml --safetyFactor 2.0
+```
+The option --windingOrMetal can currently not be defined in a config file and must be given explicitly for metal simulation (default is winding).
+
+## Contributing to _tankoh2_
+
+We welcome your contribution!
+
+If you want to provide a code change, please:
+
+* Create a fork of the project.
+* Develop the feature/patch
+* Provide a merge request.
+
+> If it is the first time that you contribute, please add yourself to the list
+> of contributors below.
+
+
+## Citing
+
+Please cite name and web address of the project
+
+## License
+
+see [license](LICENSE.md)
+
+## Change Log
+
+see [changelog](changelog.md)
+
+## Authors
+
+[Sebastian Freund](mailto:sebastian.freund@dlr.de)
+[Caroline Lüders](mailto:caroline.lueders@dlr.de)
+[Linus Jacobsen](mailto:linus.jacobsen@dlr.de)
+[Felipe Franzoni](mailto:felipe.franzoni@dlr.de)
+

tankoh2-2.7.1/README.md

@@ -0,0 +1,191 @@
+# tankoh2
+
+[![pipeline status](https://gitlab.com/DLR-SY/tank/tankoh2/badges/master/pipeline.svg)](https://gitlab.com/DLR-SY/tank/tankoh2/-/commits/master)
+[![coverage report](https://gitlab.com/DLR-SY/tank/tankoh2/badges/master/coverage.svg)](https://gitlab.com/DLR-SY/tank/tankoh2/-/commits/master)
+[![Latest Release](https://gitlab.com/DLR-SY/tank/tankoh2/-/badges/release.svg)](https://gitlab.com/DLR-SY/tank/tankoh2/-/releases)
+
+
+Design and optimization of H2 tanks.
+
+For metal structures, tankoh2 is a standalone pre-design tool.
+For CFRP structures, a detailed winding optimization is performed.
+The winding simulation is carried out by [µChain](https://www.mefex.de/software/)
+
+## Features
+
+- Material/layup read/write
+- Define requirements for cryogenic or high-pressure hydrogen storage
+- Create dome (spherical, isotensoid, torisspherical or conical) and liner from cylindrical length and radius or using a dome contour
+- Setup of a vessel model
+- Optimization of each layer with respect to minimizing puck fibre failure, bending loads, and maintaining a good contour
+- Create and run DOE with support of DLR tools (delismm, fa_pyutils)
+- Routines for the improvement of the FEM model generatred by Abaqus CAE
+- Planned features:
+  - Global optimization of
+    - All angles of helical layers
+    - All hoop layer shifts
+    - Target: mass minimization
+    - Constraint: puck fibre failure
+  - Improved DOE: Liner and fitting adjustment w.r.t. vessel geometry
+  - Abaqus: introduction of the abaqus solver at the end of the optimization process
+
+## Documentation
+Here is the full [Documentation](https://dlr-sy.gitlab.io/tank/tankoh2/)
+
+## Installation
+
+### Installation for users
+Coming soon: installation via pypi using `pip install tankoh2`
+
+When tankoh2 is installed, please follow the steps in [Settings File](#settings-file).
+
+### Installation from source
+- Get tankoh2 from
+  > https://gitlab.com/DLR-SY/tank/tankoh2.git
+- Install python 3.10 (On the Windows Installer, check the advanced option to add Python to your path and to install pip)
+- Install poetry
+  > pip install poetry
+- Install requirements for the project
+  > cd <path_to_tankoh2>
+  > poetry install
+- When tankoh2 is installed, please follow the steps in [Settings File](#settings-file).
+
+### For winding: Path to µChain
+
+Add an environment variable named MYCROPYCHAINPATH
+and set its value to the path of your [µChain](https://www.mefex.de/software/) installation.
+
+Old Method, will be deprecated soon: Alternatively, in the folder `/src/tankoh2/`, create a file `settings.json`
+and include the path here.
+
+```
+{
+  "mycropychainPath": "<path_to_muChain>"
+}
+```
+
+### Activate the environment
+
+This needs to be done whenever you want to use tankoh2.
+First, navigate into tankoh2's source directory.
+
+```
+cd <path_to_tankoh2>/src
+```
+
+Then, before running tankoh2, you need to activate the python environment created by poetry during the installation. Alternatively replace 'python' in the commands with 'poetry run'.
+
+```
+poetry shell
+```
+
+### Test the installation
+
+```
+python -m tankoh2 --help
+```
+
+You can perform a standalone test for metal tanks
+
+```
+python -m tankoh2 --materialName alu2219 --windingOrMetal metal --domeType circle
+```
+
+### Developers
+- Follow the steps [Installation from source](#installation-from-source) above
+- Install all dev dependencies and test dependencies listed in ``pyproject.toml``
+
+#### Pre-Commit Hooks
+
+Developers may also install the pre-commit hook.
+
+**Precommit**
+1. If not installed: install the pre-commit
+   > pip install pre-commit
+2. In the tankoh2 folder
+   > pre-commit install
+
+This enables the pre-commit hooks defined in _.pre-commit-config.yaml_
+and eases your commits and successful pipline runs. You can test pre-commit by running
+> pre-commit run
+
+### Requirements
+
+see **tool.poetry.dependencies** section in [pyproject.toml](pyproject.toml)
+
+FreeCAD is required for conical domes
+
+## Usage
+A full list the available parameters is created with
+
+```
+python -m tankoh2 --help
+```
+
+### Winding
+
+For winding mode, a valid µWind license is required!
+Run the following, to start a winding optimization.
+
+```
+python -m tankoh2
+```
+
+### Metal
+
+A design run for metal structures can be run by
+
+```
+python -m tankoh2 --materialName alu2219 --windingOrMetal metal --domeType circle
+```
+
+### Config Files:
+It's easiest to write design config files in .yaml format to define any parameters for the winding or metal simulation. Using config files, it's possible to reproduce and modify runs.
+Config files need to be put in the folder tankoh2/designs and are used via the option --configFile [nameOfFile.yaml]. For example:
+
+```
+python -m tankoh2 --configFile 700bar_example.yaml
+```
+
+Any non-default parameters can be defined in parameter:value pairs. All possible parameters with descriptions can be seen in defaults.yaml and in the documentation. Config files can also recursively include other configFiles as parameters, whose parameters can be overwritten.
+The parameters which were used in each run are also saved in .yaml format in the run directory. These directories are located under tankoh2/tmp by default.
+
+Parameters given in config files are overwritten by parameters supplied explicitly via options.
+
+```
+python -m tankoh2 --configFile 700bar_example.yaml --safetyFactor 2.0
+```
+The option --windingOrMetal can currently not be defined in a config file and must be given explicitly for metal simulation (default is winding).
+
+## Contributing to _tankoh2_
+
+We welcome your contribution!
+
+If you want to provide a code change, please:
+
+* Create a fork of the project.
+* Develop the feature/patch
+* Provide a merge request.
+
+> If it is the first time that you contribute, please add yourself to the list
+> of contributors below.
+
+
+## Citing
+
+Please cite name and web address of the project
+
+## License
+
+see [license](LICENSE.md)
+
+## Change Log
+
+see [changelog](changelog.md)
+
+## Authors
+
+[Sebastian Freund](mailto:sebastian.freund@dlr.de)
+[Caroline Lüders](mailto:caroline.lueders@dlr.de)
+[Linus Jacobsen](mailto:linus.jacobsen@dlr.de)
+[Felipe Franzoni](mailto:felipe.franzoni@dlr.de)

tankoh2-2.7.1/pyproject.toml

@@ -0,0 +1,86 @@
+# SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT
+
+[project]
+name = "tankoh2"
+version = "2.7.1"
+description = "Design and optimization of H2 tanks for high pressure applications and cryogenic hydrogen storage"
+license = "MIT"
+authors = [{name = "Sebastian Freund", email = "sebastian.freund@dlr.de>"},
+           {name = "Caroline Lüders", email = "caroline.lueders@dlr.de>"},
+           {name = "Linus Jacobsen", email = "linus.jacobsen@dlr.de>"},
+           {name = "Felipe Franzoni", email = "felipe.franzoni@dlr.de>"},
+           {name = "Christopher Rickert", email = "christopher.rickert@dlr.de"}]
+readme = "README.md"
+include = ["changelog.md", "LICENSES/MIT.txt"]
+keywords = ["lh2 tank", "winding", "hydrogen", "storage"]
+requires-python = ">=3.9,<4.0"
+dependencies = [
+    "numpy<2",
+    "scipy",
+    "pandas",
+    "matplotlib",
+    "CoolProp",
+    "ruamel.yaml",
+    "defusedxml",
+    "openturns",
+]
+
+[project.urls]
+Homepage = "https://gitlab.dlr.de/sy-stm/software//tankoh2"
+Changelog = "https://gitlab.dlr.de/sy-stm/software/tankoh2/-/blob/master/changelog.md"
+Documentation = "https://sy-stm.pages.gitlab.dlr.de/software/tankoh2/"
+Repository = "https://gitlab.com/DLR-SY/tank/tankoh2"
+
+[[tool.poetry.source]]
+name = "PyPI"
+priority = "primary"
+
+[[tool.poetry.source]]
+name = "dlr-sy-stm"
+url = "https://gitlab.dlr.de/api/v4/groups/38226/-/packages/pypi/simple"
+priority = "supplemental"
+
+[tool.poetry]
+include = [{ path = "src"}]
+
+[tool.poetry.scripts]
+#sample-calculator = "sample_calculator.main:cmd_main"
+
+[tool.poetry.group.dev.dependencies]
+flake8 = "*"
+black = "*"
+isort = "*"
+reuse = "*"
+bandit = "*"
+setuptools = "*"
+Sphinx = "*"
+sphinx_rtd_theme = "*"
+sphinxcontrib-bibtex = "*"
+sphinxcontrib-mermaid = "*"
+pre-commit = "*"
+
+[tool.poetry.group.test.dependencies]
+pytest = "*"
+pytest-cov = "*"
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.html]
+directory = "build/htmlcov"
+
+[tool.black]
+line-length = 120
+exclude = "docs"
+
+[tool.isort]
+line_length = 120
+skip = "docs"
+profile = "black"
+
+[tool.pytest.ini_options]
+pythonpath = [
+  ".", "src",
+]

tankoh2-2.7.1/src/tankoh2/__about__.py

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2023 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Central information about the software package
+
+It is a single location for this information.
+See https://packaging.python.org/en/latest/single_source_version.html
+variant 3.
+"""
+
+import datetime
+from os.path import abspath, basename, dirname
+
+try:
+    __programDir__ = dirname(abspath(__file__))
+    if not "site-packages" in __programDir__:
+        # not installed
+        __programDir__ = dirname(dirname(__programDir__))
+
+    __title__ = basename(dirname(__file__))
+except NameError:
+    # in case the file is analyzed via exec(), there is no __file__ variable.
+    # In this case __programDir__ and __title__ must be defined elsewhere
+    __programDir__ = None
+    __title__ = None
+
+__description__ = "Design and optimization of H2 tanks using muChain"
+__version__ = "2.4.2"
+__author__ = "Sebastian Freund, Caroline Lueders"
+__email__ = "sebastian.freund@dlr.de"
+__license__ = "MIT"
+__copyright__ = "Copyright (C) 2023 Deutsches Zentrum fuer Luft- und Raumfahrt(DLR, German Aerospace Center)"
+__url__ = "https://github.com/sfreund-DLR/tankoh2"
+__keywords__ = "tank h2 optimization design fem model"

tankoh2-2.7.1/src/tankoh2/__init__.py

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2023 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT
+
+"""
+h2 tank optimization
+"""
+
+import logging
+import sys
+
+from tankoh2.__about__ import __author__, __description__, __programDir__, __title__, __version__
+from tankoh2.settings import PychainWrapper
+
+# main program information
+name = __title__
+programDir = __programDir__
+version = __version__
+description = __description__
+author = __author__
+
+
+# create logger
+level = logging.INFO
+formatter = logging.Formatter("%(levelname)s\t%(asctime)s: %(message)s")
+handler = logging.StreamHandler(sys.stdout)
+handler.setLevel(level)
+handler.formatter = formatter
+log = logging.getLogger(f"{name}_logger")
+log.handlers.append(handler)
+log.setLevel(level)
+
+# make mycropychain available
+pychainIsLoaded = False
+pychain = PychainWrapper()

tankoh2-2.7.1/src/tankoh2/__main__.py

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: 2023 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT
+
+import sys
+from argparse import ArgumentDefaultsHelpFormatter, ArgumentParser
+
+from tankoh2 import description, name
+from tankoh2.arguments import allArgs
+from tankoh2.control.control_metal import createDesign as createDesignMetal
+from tankoh2.control.control_winding import createDesign as createDesignWinding
+from tankoh2.control.genericcontrol import parseConfigFile
+from tankoh2.service.exception import Tankoh2Error
+
+
+def main():
+    parserDesc = f"""{description}.
+    Use the following optional arguments to customize the tank design.
+    Any argument not given, will be extended by the ones defined in
+    tankoh2.design.existingdesigns.defaultDesign."""
+    parser = ArgumentParser(
+        prog=name, description=parserDesc, add_help=False, formatter_class=ArgumentDefaultsHelpFormatter
+    )
+
+    grouped = allArgs.groupby("group")
+    groupNames = allArgs["group"].unique()
+
+    # if the help is requested, all defaults should be listed. If not, it is important to know which params are set explicitly
+    includeDefaults = True if "--help" in sys.argv else False
+
+    for groupName in groupNames:
+        argsGroup = allArgs[allArgs["group"] == groupName]
+        parserGroup = parser.add_argument_group(groupName)
+        for argName, group, metavar, default, dataType, helpStr, action in argsGroup.iloc:
+            kwargs = {}
+            kwargs.update({"metavar": metavar} if metavar else {})
+            if includeDefaults:
+                kwargs.update({"default": default})
+                kwargs.update({"action": action} if action else {})
+            kwargs.update({"type": dataType} if dataType else {})
+            parserGroup.add_argument(f"--{argName}", help=helpStr, **kwargs)
+
+    options = parser.parse_args()
+    params = {key: val for key, val in vars(options).items() if val is not None}
+    windingOrMetal = params.pop("windingOrMetal").lower() if "windingOrMetal" in params else None
+    if "configFile" in params and params["configFile"] is not None:
+        configArgs = parseConfigFile(params["configFile"])
+        if "windingOrMetal" in configArgs:
+            windingOrMetal = configArgs["windingOrMetal"].lower()
+    if windingOrMetal is None:
+        windingOrMetal = "winding"
+    params = {key: value for key, value in params.items() if value != parser.get_default(key)}
+    # don't pass default values
+    try:
+        if windingOrMetal == "winding":
+            createDesignWinding(**params)
+        elif windingOrMetal == "metal":
+            createDesignMetal(**params)
+        else:
+            raise Tankoh2Error(
+                f'Parameter "windingOrMetal" can only be one of [winding, metal] but got ' f"{windingOrMetal}"
+            )
+    except:
+        sys.stdout.flush()
+        raise
+
+
+if __name__ == "__main__":
+    main()

tankoh2-2.7.1/src/tankoh2/abq_cae/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2023 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT