cubitpy 0.0.1__tar.gz

cubitpy-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-2025 CubitPy Authors
+
+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.

cubitpy-0.0.1/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: cubitpy
+Version: 0.0.1
+Summary: CubitPy: Utility functions and 4C related functionality for the Cubit and Coreform python interface
+Author-email: Ivo Steinbrecher <ivo.steinbrecher@unibw.de>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/imcs-compsim/cubitpy/
+Project-URL: Issues, https://github.com/imcs-compsim/cubitpy/issues/
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: execnet==1.9.0
+Requires-Dist: netCDF4
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: coverage-badge; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+[![build-test](https://github.com/imcs-compsim/cubitpy/actions/workflows/.github/workflows/build-test.yml/badge.svg)](https://github.com/imcs-compsim/cubitpy/actions/workflows/.github/workflows/build-test.yml)
+
+# CubitPy
+
+Utility functions and 4C related functionality for the Cubit and Coreform python interface,
+Especially for the creation of input files for 4C.
+
+## Usage
+
+A tutorial can be found in the `/tutorial` directory.
+
+## Contributing
+
+If you are interested in contributing to CubitPy, we welcome your collaboration.
+For general questions, feature request and bug reports please open an [issue](https://github.com/imcs-compsim/cubitpy/issues).
+
+If you contribute actual code, fork the repository and make the changes in a feature branch.
+Depending on the topic and amount of changes you also might want to open an [issue](https://github.com/imcs-compsim/cubitpy/issues).
+To merge your changes into the CubitPy repository, create a pull request to the `main` branch.
+A few things to keep in mind:
+- It is highly encouraged to add tests covering the functionality of your changes, see the test suite in `tests/`.
+- CubitPy uses `black` to format python code.
+  Make sure to apply `black` to the changed source files.
+- Feel free to add yourself to the [CONTRIBUTORS](CONTRIBUTORS) file.
+
+## Installation
+
+CubitPy is developed with `python3.12`.
+Other versions of Python might lead to issues.
+It is recommended to use a python environment container such as `conda` or `venv`.
+- `conda`:
+  A [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) environment can be created and loaded with
+  ```bash
+  conda create -n cubitpy python=3.12
+  conda activate cubitpy
+  ```
+- `venv`: Chose an appropriate directory for this, e.g., `/home/user/opt`.
+  A virtual environment can be setup with
+  - On Debian systems the following packages have to be installed:
+    ```bash
+    sudo apt-get install python3-venv python3-dev
+    ```
+  - Create and load the environment
+    ```bash
+    cd <path-to-env-folder>
+    python -m venv cubitpy-env
+    source cubitpy-env/bin/activate
+    ```
+
+To install `cubitpy` go to the repository root directory
+```bash
+cd path_to_cubitpy
+```
+
+And install `cubitpy` via `pip`
+```bash
+pip install .
+```
+
+If you intend to actively develop `cubitpy`, install it in *editable mode*
+```bash
+pip install -e .
+```
+
+To run CubitPy it is required to set an environment variable with the path to the Cubit directory. This should be the "root" directory for the installation.
+```bash
+export CUBIT_ROOT=path_to_cubit_root_directory
+```
+
+To check if everything worked as expected, run the tests from within the `tests` directory
+```bash
+cd path_to_cubitpy/tests
+pytest -q testing.py
+```
+
+If you intend to actively develop CubitPy, please make sure to install the `pre-commit` hook within the python environment to follow our style guides:
+```bash
+pre-commit install
+```

cubitpy-0.0.1/README.md

@@ -0,0 +1,79 @@
+[![build-test](https://github.com/imcs-compsim/cubitpy/actions/workflows/.github/workflows/build-test.yml/badge.svg)](https://github.com/imcs-compsim/cubitpy/actions/workflows/.github/workflows/build-test.yml)
+
+# CubitPy
+
+Utility functions and 4C related functionality for the Cubit and Coreform python interface,
+Especially for the creation of input files for 4C.
+
+## Usage
+
+A tutorial can be found in the `/tutorial` directory.
+
+## Contributing
+
+If you are interested in contributing to CubitPy, we welcome your collaboration.
+For general questions, feature request and bug reports please open an [issue](https://github.com/imcs-compsim/cubitpy/issues).
+
+If you contribute actual code, fork the repository and make the changes in a feature branch.
+Depending on the topic and amount of changes you also might want to open an [issue](https://github.com/imcs-compsim/cubitpy/issues).
+To merge your changes into the CubitPy repository, create a pull request to the `main` branch.
+A few things to keep in mind:
+- It is highly encouraged to add tests covering the functionality of your changes, see the test suite in `tests/`.
+- CubitPy uses `black` to format python code.
+  Make sure to apply `black` to the changed source files.
+- Feel free to add yourself to the [CONTRIBUTORS](CONTRIBUTORS) file.
+
+## Installation
+
+CubitPy is developed with `python3.12`.
+Other versions of Python might lead to issues.
+It is recommended to use a python environment container such as `conda` or `venv`.
+- `conda`:
+  A [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) environment can be created and loaded with
+  ```bash
+  conda create -n cubitpy python=3.12
+  conda activate cubitpy
+  ```
+- `venv`: Chose an appropriate directory for this, e.g., `/home/user/opt`.
+  A virtual environment can be setup with
+  - On Debian systems the following packages have to be installed:
+    ```bash
+    sudo apt-get install python3-venv python3-dev
+    ```
+  - Create and load the environment
+    ```bash
+    cd <path-to-env-folder>
+    python -m venv cubitpy-env
+    source cubitpy-env/bin/activate
+    ```
+
+To install `cubitpy` go to the repository root directory
+```bash
+cd path_to_cubitpy
+```
+
+And install `cubitpy` via `pip`
+```bash
+pip install .
+```
+
+If you intend to actively develop `cubitpy`, install it in *editable mode*
+```bash
+pip install -e .
+```
+
+To run CubitPy it is required to set an environment variable with the path to the Cubit directory. This should be the "root" directory for the installation.
+```bash
+export CUBIT_ROOT=path_to_cubit_root_directory
+```
+
+To check if everything worked as expected, run the tests from within the `tests` directory
+```bash
+cd path_to_cubitpy/tests
+pytest -q testing.py
+```
+
+If you intend to actively develop CubitPy, please make sure to install the `pre-commit` hook within the python environment to follow our style guides:
+```bash
+pre-commit install
+```

cubitpy-0.0.1/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cubitpy"
+authors = [
+  {name = "Ivo Steinbrecher", email = "ivo.steinbrecher@unibw.de"},
+]
+description = "CubitPy: Utility functions and 4C related functionality for the Cubit and Coreform python interface"
+readme = "README.md"
+license = "MIT"
+dependencies = [
+  "execnet==1.9.0",
+  "netCDF4",
+  "numpy"
+]
+version = "0.0.1"
+
+[project.urls]
+Repository = "https://github.com/imcs-compsim/cubitpy/"
+Issues = "https://github.com/imcs-compsim/cubitpy/issues/"
+
+[project.optional-dependencies]
+dev = [
+  "coverage",
+  "coverage-badge",
+  "setuptools", # Needed for coverage-badge
+  "pre-commit",
+  "pytest"
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

cubitpy-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cubitpy-0.0.1/src/CubitPy.egg-info/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: cubitpy
+Version: 0.0.1
+Summary: CubitPy: Utility functions and 4C related functionality for the Cubit and Coreform python interface
+Author-email: Ivo Steinbrecher <ivo.steinbrecher@unibw.de>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/imcs-compsim/cubitpy/
+Project-URL: Issues, https://github.com/imcs-compsim/cubitpy/issues/
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: execnet==1.9.0
+Requires-Dist: netCDF4
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: coverage-badge; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+[![build-test](https://github.com/imcs-compsim/cubitpy/actions/workflows/.github/workflows/build-test.yml/badge.svg)](https://github.com/imcs-compsim/cubitpy/actions/workflows/.github/workflows/build-test.yml)
+
+# CubitPy
+
+Utility functions and 4C related functionality for the Cubit and Coreform python interface,
+Especially for the creation of input files for 4C.
+
+## Usage
+
+A tutorial can be found in the `/tutorial` directory.
+
+## Contributing
+
+If you are interested in contributing to CubitPy, we welcome your collaboration.
+For general questions, feature request and bug reports please open an [issue](https://github.com/imcs-compsim/cubitpy/issues).
+
+If you contribute actual code, fork the repository and make the changes in a feature branch.
+Depending on the topic and amount of changes you also might want to open an [issue](https://github.com/imcs-compsim/cubitpy/issues).
+To merge your changes into the CubitPy repository, create a pull request to the `main` branch.
+A few things to keep in mind:
+- It is highly encouraged to add tests covering the functionality of your changes, see the test suite in `tests/`.
+- CubitPy uses `black` to format python code.
+  Make sure to apply `black` to the changed source files.
+- Feel free to add yourself to the [CONTRIBUTORS](CONTRIBUTORS) file.
+
+## Installation
+
+CubitPy is developed with `python3.12`.
+Other versions of Python might lead to issues.
+It is recommended to use a python environment container such as `conda` or `venv`.
+- `conda`:
+  A [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) environment can be created and loaded with
+  ```bash
+  conda create -n cubitpy python=3.12
+  conda activate cubitpy
+  ```
+- `venv`: Chose an appropriate directory for this, e.g., `/home/user/opt`.
+  A virtual environment can be setup with
+  - On Debian systems the following packages have to be installed:
+    ```bash
+    sudo apt-get install python3-venv python3-dev
+    ```
+  - Create and load the environment
+    ```bash
+    cd <path-to-env-folder>
+    python -m venv cubitpy-env
+    source cubitpy-env/bin/activate
+    ```
+
+To install `cubitpy` go to the repository root directory
+```bash
+cd path_to_cubitpy
+```
+
+And install `cubitpy` via `pip`
+```bash
+pip install .
+```
+
+If you intend to actively develop `cubitpy`, install it in *editable mode*
+```bash
+pip install -e .
+```
+
+To run CubitPy it is required to set an environment variable with the path to the Cubit directory. This should be the "root" directory for the installation.
+```bash
+export CUBIT_ROOT=path_to_cubit_root_directory
+```
+
+To check if everything worked as expected, run the tests from within the `tests` directory
+```bash
+cd path_to_cubitpy/tests
+pytest -q testing.py
+```
+
+If you intend to actively develop CubitPy, please make sure to install the `pre-commit` hook within the python environment to follow our style guides:
+```bash
+pre-commit install
+```

cubitpy-0.0.1/src/CubitPy.egg-info/SOURCES.txt

@@ -0,0 +1,31 @@
+LICENSE
+README.md
+pyproject.toml
+src/CubitPy.egg-info/PKG-INFO
+src/CubitPy.egg-info/SOURCES.txt
+src/CubitPy.egg-info/dependency_links.txt
+src/CubitPy.egg-info/requires.txt
+src/CubitPy.egg-info/top_level.txt
+src/cubitpy/__init__.py
+src/cubitpy/conf.py
+src/cubitpy/cubit_group.py
+src/cubitpy/cubit_utility.py
+src/cubitpy/cubitpy.py
+src/cubitpy/cubitpy_to_dat.py
+src/cubitpy/cubitpy_types.py
+src/cubitpy/geometry_creation_functions.py
+src/cubitpy/mesh_creation_functions.py
+src/cubitpy.egg-info/PKG-INFO
+src/cubitpy.egg-info/SOURCES.txt
+src/cubitpy.egg-info/dependency_links.txt
+src/cubitpy.egg-info/requires.txt
+src/cubitpy.egg-info/top_level.txt
+src/cubitpy/cubit_wrapper/__init__.py
+src/cubitpy/cubit_wrapper/cubit_wrapper_client.py
+src/cubitpy/cubit_wrapper/cubit_wrapper_host.py
+src/cubitpy/cubit_wrapper/cubit_wrapper_utility.py
+src/tutorial/__init__.py
+src/tutorial/tutorial.py
+tests/test_cubitpy.py
+tests/test_delete.py
+tests/test_tutorial.py

cubitpy-0.0.1/src/CubitPy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cubitpy-0.0.1/src/CubitPy.egg-info/requires.txt

@@ -0,0 +1,10 @@
+execnet==1.9.0
+netCDF4
+numpy
+
+[dev]
+coverage
+coverage-badge
+setuptools
+pre-commit
+pytest

cubitpy-0.0.1/src/CubitPy.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+cubitpy
+tutorial

cubitpy-0.0.1/src/cubitpy/__init__.py

@@ -0,0 +1,34 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018-2025 CubitPy Authors
+#
+# 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.
+"""This module contains extensions and utility functions for the cubit python
+interface."""
+
+from cubitpy.conf import cupy
+from cubitpy.cubitpy import CubitPy
+
+# Define the items that will be exported by default.
+__all__ = [
+    # cubit options.
+    "cupy",
+    # Cubit objects.
+    "CubitPy",
+]

cubitpy-0.0.1/src/cubitpy/conf.py

@@ -0,0 +1,158 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018-2025 CubitPy Authors
+#
+# 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.
+"""This module defines a global object that manages all kind of stuff regarding
+cubitpy."""
+
+import getpass
+import glob
+import os
+import shutil
+from sys import platform
+
+from cubitpy.cubitpy_types import (
+    BoundaryConditionType,
+    CubitItems,
+    ElementType,
+    FiniteElementObject,
+    GeometryType,
+)
+
+
+def get_path(environment_variable, test_function, *, throw_error=True):
+    """Check if he environment variable is set and the path exits."""
+    if environment_variable in os.environ.keys():
+        if test_function(os.environ[environment_variable]):
+            return os.environ[environment_variable]
+
+    # No valid path found or given.
+    if throw_error:
+        raise ValueError("Path for {} not found!".format(environment_variable))
+    else:
+        return None
+
+
+class CubitOptions(object):
+    """Object for types in cubitpy."""
+
+    def __init__(self):
+        # Temporary directory for cubitpy.
+        self.temp_dir = os.path.join(
+            "/tmp/cubitpy_{}".format(getpass.getuser()),  # nosec
+            "pid_{}".format(os.getpid()),
+        )
+        self.temp_log = os.path.join(self.temp_dir, "cubitpy.log")
+
+        # Check if temp path exits, if not create it.
+        os.makedirs(self.temp_dir, exist_ok=True)
+
+        # Geometry types.
+        self.geometry = GeometryType
+
+        # Finite element types.
+        self.finite_element_object = FiniteElementObject
+
+        # Element shape types.
+        self.element_type = ElementType
+
+        # Cubit internal items.
+        self.cubit_items = CubitItems
+
+        # Boundary condition type.
+        self.bc_type = BoundaryConditionType
+
+        # Tolerance for geometry.
+        self.eps_pos = 1e-10
+
+    @staticmethod
+    def get_cubit_root_path(**kwargs):
+        """Get Path to cubit root directory."""
+        return get_path("CUBIT_ROOT", os.path.isdir, **kwargs)
+
+    @classmethod
+    def get_cubit_exe_path(cls, **kwargs):
+        """Get Path to cubit executable."""
+        cubit_root = cls.get_cubit_root_path(**kwargs)
+        if platform == "linux" or platform == "linux2":
+            if cupy.is_coreform():
+                return os.path.join(cubit_root, "bin", "coreform_cubit")
+            else:
+                return os.path.join(cubit_root, "cubit")
+        elif platform == "darwin":
+            if cupy.is_coreform():
+                cubit_exe_name = cubit_root.split("/")[-1].split(".app")[0]
+                return os.path.join(cubit_root, "Contents/MacOS", cubit_exe_name)
+            else:
+                return os.path.join(cubit_root, "Contents/MacOS/Cubit")
+        else:
+            raise ValueError("Got unexpected platform")
+
+    @classmethod
+    def get_cubit_lib_path(cls, **kwargs):
+        """Get Path to cubit lib directory."""
+        cubit_root = cls.get_cubit_root_path(**kwargs)
+        if platform == "linux" or platform == "linux2":
+            return os.path.join(cubit_root, "bin")
+        elif platform == "darwin":
+            if cls.is_coreform():
+                return os.path.join(cubit_root, "Contents/lib")
+            else:
+                return os.path.join(cubit_root, "Contents/MacOS")
+        else:
+            raise ValueError("Got unexpected platform")
+
+    @classmethod
+    def get_cubit_interpreter(cls):
+        """Get the path to the python interpreter to be used for CubitPy."""
+        cubit_root = cls.get_cubit_root_path()
+        if cls.is_coreform():
+            pattern = "**/python3"
+            full_pattern = os.path.join(cubit_root, pattern)
+            python3_matches = glob.glob(full_pattern, recursive=True)
+            python3_files = [path for path in python3_matches if os.path.isfile(path)]
+            if not len(python3_files) == 1:
+                raise ValueError(
+                    "Could not find the path to the cubit python interpreter"
+                )
+            cubit_python_interpreter = python3_files[0]
+            return cubit_python_interpreter
+        else:
+            if shutil.which("python2.7") is not None:
+                return "python2.7"
+
+            imcs_python2_path = "/imcs/public/compsim/opt/Python-2.7.18/python"
+            if os.path.exists(imcs_python2_path):
+                return imcs_python2_path
+
+            raise ValueError("Could not find a python2 interpreter")
+
+    @classmethod
+    def is_coreform(cls):
+        """Return if the given path is a path to cubit coreform."""
+        cubit_root = cls.get_cubit_root_path()
+        if "15.2" in cubit_root:
+            return False
+        else:
+            return True
+
+
+# Global object with options for cubitpy.
+cupy = CubitOptions()