patme 0.4.4__tar.gz

patme-0.4.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Freund, Sebastian
+
+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.

patme-0.4.4/LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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.

patme-0.4.4/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.3
+Name: patme
+Version: 0.4.4
+Summary: Utilities for software builds, documentation, cluster interaction, calling fem tools, logging, exceptions and simple geometric and mechanical operations.
+License: DLR 2025
+Keywords: build,cluster,fem,log,exception
+Author: Sebastian Freund
+Author-email: sebastian.freund@dlr.de
+Maintainer: Garbade, Marc
+Maintainer-email: <marc.garbade@dlr.de>
+Requires-Python: >=3.9,<4.0
+Classifier: License :: Other/Proprietary 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: importlib_metadata
+Requires-Dist: numpy (<2)
+Requires-Dist: scipy
+Requires-Dist: sshconf
+Requires-Dist: tomlkit
+Project-URL: Changelog, https://gitlab.dlr.de/sy-stm/software/patme/-/blob/master/changelog.md
+Project-URL: Documentation, https://sy-stm.pages.gitlab.dlr.de/software/patme/
+Project-URL: Homepage, https://gitlab.dlr.de/fa_sw/patme
+Project-URL: Repository, https://gitlab.dlr.de/fa_sw/patme
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
+
+SPDX-License-Identifier: MIT
+-->
+
+# patme
+
+Utilities for basic software engineering, geometry, mechanics support and infrastructure handling.
+
+[![pipeline status](https://gitlab.dlr.de/sy-stm/software/patme/badges/master/pipeline.svg)](https://gitlab.dlr.de/sy-stm/software/patme/-/commits/master)
+[![coverage report](https://gitlab.dlr.de/sy-stm/software/patme/badges/master/coverage.svg)](https://ggitlab.dlr.de/sy-stm/software/patme/-/commits/master)
+[![Latest Release](https://gitlab.dlr.de/sy-stm/software/patme/-/badges/release.svg)](https://gitlab.dlr.de/sy-stm/software/patme/-/releases)
+
+## Features
+The full documentation can be found [here](https://sy-stm.pages.gitlab.dlr.de/software/patme/).
+
+### Software Engineering Features
+- software builds
+- release automation
+- build documentation (sphinx)
+- logging
+
+Planned items:
+- exception hooks
+- (potentially) decorators
+- Create RCE components and push them on an RCE server
+
+### Common useful features
+Planned items:
+- Call FEM software
+- Plot samples (Matplotlib, Latex-Pgfplots)
+
+### DLR-SY specific features
+Planned items:
+- SSH interface
+- SSH based cluster interaction
+- Run several jobs (FEM, python, matlab etc.) as samples with various parallelization options
+    - parallel local
+    - parallel remote
+    - asynchronous sampling (e.g. dependend on license availability)
+
+
+software builds, documentation, cluster interaction, calling fem tools, logging, exceptions.
+
+
+
+## Installation
+
+At least you require Python 3.
+
+### Installation from source
+Get patme source from
+
+> https://gitlab.dlr.de/sy-stm/software/patme.git
+
+and add the /src folder to pythonpath in the environment variables
+
+### Installation as python package
+Install it from [the gitlab packacke registry](https://gitlab.dlr.de/sy-stm/software/patme/-/packages)
+
+You can download the latest artifact (*.whl) and install it using
+
+
+> cd patme
+> python setup.py install patme<version>.whl
+
+
+### Test the installation
+In python execute:
+
+> import patme
+
+### Developers
+
+Developers may also install the pre-commit hook.
+
+**Precommit**
+1. install the pre-commit
+   > pip install pre-commit
+2. In the patme folder
+   > pre-commit install
+
+This enables the pre-commit hooks defined in _.pre-commit-config.yaml_
+and eases your commits and successful pipline runs.
+
+
+## CI Pipeline and Jobs for Developers
+
+If you encounter any failed job on the pipeline you can run them locally for more information.
+(prerequisite: have _make_ and _poetry_ installed [e.g. conda install make poetry])
+
+See all availabe make targets used for the ci-jobs
+
+> make list
+
+Find the target with matching names and execute them locally e.g.:
+> make test
+
+If **check-formatting** fails, run the following to fix issues.
+> make formatting
+
+If **check-license-metadata** fails, run
+> make check-license-metadata
+
+identify the corresponding filename and run the following (include the filename in $filename)
+> poetry run reuse addheader --copyright="German Aerospace Center (DLR)" --license="MIT" $filename
+
+## Contributing to _patme_
+
+We welcome your contribution!
+
+If you want to provide a code change, please:
+
+* Create a fork of the GitLab 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
+
+No citing required
+
+## License
+
+MIT
+
+## Change Log
+
+see [changelog](changelog.md)
+
+## Authors
+
+[Sebastian Freund](mailto:sebastian.freund@dlr.de)
+[Andreas Schuster](mailto:andreas.schuster@dlr.de)
+

patme-0.4.4/README.md

@@ -0,0 +1,138 @@
+<!--
+SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
+
+SPDX-License-Identifier: MIT
+-->
+
+# patme
+
+Utilities for basic software engineering, geometry, mechanics support and infrastructure handling.
+
+[![pipeline status](https://gitlab.dlr.de/sy-stm/software/patme/badges/master/pipeline.svg)](https://gitlab.dlr.de/sy-stm/software/patme/-/commits/master)
+[![coverage report](https://gitlab.dlr.de/sy-stm/software/patme/badges/master/coverage.svg)](https://ggitlab.dlr.de/sy-stm/software/patme/-/commits/master)
+[![Latest Release](https://gitlab.dlr.de/sy-stm/software/patme/-/badges/release.svg)](https://gitlab.dlr.de/sy-stm/software/patme/-/releases)
+
+## Features
+The full documentation can be found [here](https://sy-stm.pages.gitlab.dlr.de/software/patme/).
+
+### Software Engineering Features
+- software builds
+- release automation
+- build documentation (sphinx)
+- logging
+
+Planned items:
+- exception hooks
+- (potentially) decorators
+- Create RCE components and push them on an RCE server
+
+### Common useful features
+Planned items:
+- Call FEM software
+- Plot samples (Matplotlib, Latex-Pgfplots)
+
+### DLR-SY specific features
+Planned items:
+- SSH interface
+- SSH based cluster interaction
+- Run several jobs (FEM, python, matlab etc.) as samples with various parallelization options
+    - parallel local
+    - parallel remote
+    - asynchronous sampling (e.g. dependend on license availability)
+
+
+software builds, documentation, cluster interaction, calling fem tools, logging, exceptions.
+
+
+
+## Installation
+
+At least you require Python 3.
+
+### Installation from source
+Get patme source from
+
+> https://gitlab.dlr.de/sy-stm/software/patme.git
+
+and add the /src folder to pythonpath in the environment variables
+
+### Installation as python package
+Install it from [the gitlab packacke registry](https://gitlab.dlr.de/sy-stm/software/patme/-/packages)
+
+You can download the latest artifact (*.whl) and install it using
+
+
+> cd patme
+> python setup.py install patme<version>.whl
+
+
+### Test the installation
+In python execute:
+
+> import patme
+
+### Developers
+
+Developers may also install the pre-commit hook.
+
+**Precommit**
+1. install the pre-commit
+   > pip install pre-commit
+2. In the patme folder
+   > pre-commit install
+
+This enables the pre-commit hooks defined in _.pre-commit-config.yaml_
+and eases your commits and successful pipline runs.
+
+
+## CI Pipeline and Jobs for Developers
+
+If you encounter any failed job on the pipeline you can run them locally for more information.
+(prerequisite: have _make_ and _poetry_ installed [e.g. conda install make poetry])
+
+See all availabe make targets used for the ci-jobs
+
+> make list
+
+Find the target with matching names and execute them locally e.g.:
+> make test
+
+If **check-formatting** fails, run the following to fix issues.
+> make formatting
+
+If **check-license-metadata** fails, run
+> make check-license-metadata
+
+identify the corresponding filename and run the following (include the filename in $filename)
+> poetry run reuse addheader --copyright="German Aerospace Center (DLR)" --license="MIT" $filename
+
+## Contributing to _patme_
+
+We welcome your contribution!
+
+If you want to provide a code change, please:
+
+* Create a fork of the GitLab 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
+
+No citing required
+
+## License
+
+MIT
+
+## Change Log
+
+see [changelog](changelog.md)
+
+## Authors
+
+[Sebastian Freund](mailto:sebastian.freund@dlr.de)
+[Andreas Schuster](mailto:andreas.schuster@dlr.de)

patme-0.4.4/pyproject.toml

@@ -0,0 +1,74 @@
+# SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT
+
+[project]
+name = "patme"
+version = "0.4.4"
+description = "Utilities for software builds, documentation, cluster interaction, calling fem tools, logging, exceptions and simple geometric and mechanical operations."
+license = "DLR 2025"
+authors = [
+    { name = "Sebastian Freund", email = "sebastian.freund@dlr.de" },
+    { name = "Andreas Schuster", email = "andreas.schuster@dlr.de" },
+]
+maintainers = [
+    {name = "Garbade, Marc", email = "<marc.garbade@dlr.de>"}]
+readme = "README.md"
+keywords = ["build", "cluster", "fem", "log", "exception"]
+requires-python = ">=3.9,<4.0"
+dependencies = [
+    "numpy<2",
+    "scipy",
+    "importlib_metadata",
+    "tomlkit",
+    "sshconf"
+]
+
+[project.urls]
+Homepage = "https://gitlab.dlr.de/fa_sw/patme"
+Changelog = "https://gitlab.dlr.de/sy-stm/software/patme/-/blob/master/changelog.md"
+Repository = "https://gitlab.dlr.de/fa_sw/patme"
+Documentation = "https://sy-stm.pages.gitlab.dlr.de/software/patme/"
+
+[tool.poetry]
+include = [{ path = "src"}]
+
+[tool.poetry.scripts]
+run-fe = "patme.femtools.fecall:run_fe_cli"
+#sample-calculator = "sample_calculator.main:cmd_main"
+
+[tool.poetry.group.opt.dependencies]
+sshconf = [{version = "*", python = "^3.7", optional=true}]
+
+[tool.poetry.group.dev.dependencies]
+flake8 = "*"
+black = "*"
+isort = "*"
+reuse = "*"
+Sphinx = "*"
+sphinx_rtd_theme = "*"
+sphinxcontrib-bibtex = "*"
+setuptools ="*" # due to problems with pybtex which sphinxcontrib-bibtex depends on. Check "make docs" on gitlab runner before removing it
+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]
+addopts = "--import-mode=importlib"

patme-0.4.4/src/fa_pyutils.py

@@ -0,0 +1,61 @@
+# Copyright (C) 2020 Deutsches Zentrum fuer Luft- und Raumfahrt(DLR, German Aerospace Center) <www.dlr.de>
+# SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT
+
+# %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+#                             patme                          #
+# %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+"""
+Top-level compatibility interface for former fa-pyutils as a standalone python package.
+
+@note: patme
+Created on 19.11.2024
+
+@version: 1.0
+----------------------------------------------------------------------------------------------
+@requires:
+       -
+
+@change:
+       -
+
+@author: garb_ma                                                     [DLR-SY,STM Braunschweig]
+----------------------------------------------------------------------------------------------
+"""
+
+## @package patme
+# Top-level compatibility interface for patme defining a new alias as a python package.
+## @authors
+# Marc Garbade
+## @date
+# 19.11.2024
+
+import os
+import pkgutil
+import sys
+
+# List of all attributes and modules available during wild import
+__all__ = []
+
+# Create a valid package name
+__package__ = os.path.splitext(os.path.basename(__file__))[0]
+
+# Import deprecated module. Create an alias.
+import patme
+
+sys.modules[__package__] = patme
+
+# Create a valid path identifier
+__path__ = [__file__]
+
+## Iterate through all modules at runtime
+# Source: https://stackoverflow.com/questions/3365740/how-to-import-all-submodules
+for loader, module_name, is_pkg in pkgutil.walk_packages(patme.__path__):
+    __all__.append(module_name)
+    _module = loader.find_module(module_name).load_module(module_name)
+    globals()[module_name] = _module
+
+if __name__ == "__main__":
+    sys.exit()
+    pass

patme-0.4.4/src/patme/__init__.py

@@ -0,0 +1,52 @@
+# Copyright (C) 2020 Deutsches Zentrum fuer Luft- und Raumfahrt(DLR, German Aerospace Center) <www.dlr.de>
+# SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Utilities for software builds, documentation, cluster interaction, calling fem tools, logging, exceptions and simple geometric and mechanical operations.
+
+"""
+from pathlib import Path
+
+import importlib_metadata
+import tomlkit
+
+name = Path(__file__).parent.name
+
+
+def getPyprojectMeta(initPath):
+    """Returns project data from pyproject.toml
+
+    :param initPath: path to the packages main __init__.py file
+    :return: dict with entries from tool.poetry in pyproject.toml
+    """
+    with open(Path(Path(initPath).parents[2], "pyproject.toml")) as pyproject:
+        file_contents = pyproject.read()
+
+    contents_dict = tomlkit.parse(file_contents)
+    try:
+        return contents_dict["project"]
+    except:
+        return contents_dict["tool"]["poetry"]
+
+
+try:
+    # package is installed
+    version = importlib_metadata.version(name)
+    programDir = str(Path(__file__).parent)
+except importlib_metadata.PackageNotFoundError:
+    # package is not installed, read pyproject.toml
+    try:
+        # We have the full GitLab repository
+        pkgMeta = getPyprojectMeta(__file__)
+        version = str(pkgMeta["version"])
+        programDir = str(Path(__file__).parents[3])
+    except FileNotFoundError:
+        # We have only the source code
+        version = str("version not provided")
+        programDir = str(Path(__file__).parent)
+
+
+# Variables
+epsilon = 1e-8

patme-0.4.4/src/patme/buildtools/__init__.py

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: MIT
+
+"""
+The modules of this package support the build and deployment of python packages.
+"""