FourCIPP 1.50.0__py3-none-any.whl

fourcipp-1.50.0.dist-info/METADATA

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: FourCIPP
+Version: 1.50.0
+Summary: A streamlined Python Parser for 4C input files
+Author: FourCIPP Authors
+License: The MIT License (MIT)
+        
+        Copyright (c) 2025 FourCIPP 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.
+Project-URL: Repository, https://github.com/4C-multiphysics/fourcipp/
+Project-URL: Issues, https://github.com/4C-multiphysics/fourcipp/issues/
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema-rs
+Requires-Dist: loguru
+Requires-Dist: numpy
+Requires-Dist: rapidyaml
+Requires-Dist: regex
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <picture>
+    <source
+      srcset="https://raw.githubusercontent.com/4C-multiphysics/fourcipp/refs/heads/main/docs/assets/fourcipp_logo_white.svg"
+      media="(prefers-color-scheme: dark)">
+    <img
+      src="https://raw.githubusercontent.com/4C-multiphysics/fourcipp/refs/heads/main/docs/assets/fourcipp_logo_black.svg"
+      width="300"
+      title="FourCIPP"
+      alt="FourCIPP logo">
+  </picture>
+</p>
+
+FourCIPP (**FourC** **I**nput **P**ython **P**arser) holds a Python Parser to simply interact with [4C](https://github.com/4C-multiphysics/4C) YAML input files. This tool provides a streamlined approach to data handling for third party tools.
+
+## Overview <!-- omit from toc -->
+- [Installation](#installation)
+  - [Python Environment](#python-environment)
+  - [Installation from PyPI](#installation-from-pypi)
+  - [Installation from Github (most recent version)](#installation-from-github-most-recent-version)
+  - [Installation from source](#installation-from-source)
+- [Quickstart example](#quickstart-example)
+- [Configuration](#configuration)
+- [Developing FourCIPP](#developing-fourcipp)
+- [Dependency Management](#dependency-management)
+- [License](#license)
+
+## Installation
+
+### Python Environment
+
+FourCIPP is a Python project supporting Python versions 3.10 - 3.13. To use FourCIPP it is recommended to install it into a virtual Python environment such as [Conda](https://anaconda.org/anaconda/conda)/[Miniforge](https://conda-forge.org/download/) or [venv](https://docs.python.org/3/library/venv.html).
+
+An exemplary [Conda](https://anaconda.org/anaconda/conda)/[Miniforge](https://conda-forge.org/download/) environment can be created and loaded with
+
+```bash
+# Create the environment (this only has to be done once)
+conda create -n fourcipp python=3.13
+# Activate the environment
+conda activate fourcipp
+```
+
+To now install FourCIPP different ways exist.
+
+### Installation from PyPI
+
+FourCIPP is published on [PyPI](https://pypi.org/project/FourCIPP/) as a universal wheel, meaning you can install it on Windows, Linux and macOS with:
+
+```bash
+pip install fourcipp
+```
+
+or a specific version with:
+
+```bash
+pip install fourcipp==0.28.0
+```
+
+### Installation from Github (most recent version)
+
+Additionally, the latest `main` version of FourCIPP can be installed directly from Github via:
+
+```bash
+pip install git+https://github.com/4C-multiphysics/fourcipp.git@main
+```
+
+### Installation from source
+
+If you intend on developing FourCIPP it is crucial to install FourCIPP from source, i.e., cloning the repository from Github. You can then either install it in a non-editable or editable fashion.
+
+- Install all requirements without fixed versions in a non-editable fashion via:
+
+  ```bash
+  # located at the root of the repository
+  pip install .
+  ```
+
+  and without fixed versions in an editable fashion via:
+
+  ```bash
+  # located at the root of the repository
+  pip install -e .
+  ```
+
+  > Note: This is the default behavior. This allows to use fourcipp within other projects without version conflicts.
+
+- Alternatively, you can install all requirements with fixed versions in a non-editable fashion with:
+
+  ```bash
+  pip install .[safe]
+  ```
+
+  and with fixed versions in an editable fashion via:
+
+  ```bash
+  # located at the root of the repository
+  pip install -e .[safe]
+  ```
+
+Once installed, FourCIPP is ready to be used 🎉
+
+## Quickstart example
+<!--example, do not remove this comment-->
+```python
+from fourcipp.fourc_input import FourCInput
+
+# Create a new 4C input via
+input_4C = FourCInput()
+
+# Or load an existing input file
+input_4C = FourCInput.from_4C_yaml(input_file_path)
+
+# Add or overwrite sections
+input_4C["PROBLEM TYPE"] = {"PROBLEMTYPE": "Structure"}
+input_4C["PROBLEM SIZE"] = {"DIM": 3, "ELEMENTS": 1_000}
+
+# Update section parameter
+input_4C["PROBLEM SIZE"]["ELEMENTS"] = 1_000_000
+
+# Add new parameter
+input_4C["PROBLEM SIZE"]["NODES"] = 10_000_000
+
+# Remove section
+removed_section = input_4C.pop("PROBLEM SIZE")
+
+# Dump to file
+input_4C.dump(input_file_path, validate=True)
+```
+<!--example, do not remove this comment-->
+
+## Configuration
+FourCIPP utilizes the `4C_metadata.yaml` and `schema.json` files generated during the 4C build to remain up-to-date with your 4C build. By default, the files for the latest 4C input version can be found in `src/fourcipp/config`. You can add custom metadata and schema paths to the configuration file `src/fourcipp/config/config.yaml` by adding a new profile:
+```yaml
+profile: your_custom_files
+profiles:
+  your_custom_files:
+    4C_metadata_path: /absolute/path/to/your/4C_metadata.yaml
+    json_schema_path: /absolute/path/to/your/4C_schema.json
+  default:
+    4C_metadata_path: 4C_metadata.yaml
+    json_schema_path: 4C_schema.json
+    description: 4C metadata from the latest successful nightly 4C build
+  4C_docker_main:
+    4C_metadata_path: /home/user/4C/build/4C_metadata.yaml
+    json_schema_path: /home/user/4C/build/4C_schema.json
+    description: 4C metadata in the main 4C docker image
+```
+and select it using the `profile` entry.
+
+
+## Developing FourCIPP
+
+If you plan on actively developing FourCIPP it is advisable to install in editable mode with the additional developer requirements like
+
+```bash
+pip install -e .[dev]
+```
+
+> Note: The developer requirements can also be installed in non-editable installs. Finally, you can install the pre-commit hook with:
+
+```bash
+pre-commit install
+```
+
+## Dependency Management
+
+To ease the dependency update process [`pip-tools`](https://github.com/jazzband/pip-tools) is utilized. To create the necessary [`requirements.txt`](./requirements.txt) file simply execute
+
+```
+pip-compile --all-extras --output-file=requirements.txt requirements.in
+````
+
+To upgrade the dependencies simply execute
+
+```
+pip-compile --all-extras --output-file=requirements.txt --upgrade requirements.in
+````
+
+## License
+
+This project is licensed under a MIT license. For further information check [`LICENSE`](./LICENSE).

fourcipp-1.50.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+fourcipp/__init__.py,sha256=4pz7DVXErSbUcLqPTaHnQfdJzKkpfZDivBqbHbTgpRE,1388
+fourcipp/fourc_input.py,sha256=U_1b3XtZpXZfRV3ZAWiZzpAKtLWWrdBXow2r3wNPWao,24720
+fourcipp/version.py,sha256=_Pf-vbXKGGS2hP-Yx1JBi6Y-zBGNCXuwL2wRrnt_z_s,706
+fourcipp/config/4C_metadata.yaml,sha256=fH7pvqpAo7aAwAPF-DGylg9MWnGvRspyE70WKePIm38,2610998
+fourcipp/config/4C_schema.json,sha256=Rvi-K3HVOO_Z5TKkuMsPmqscTE7XUiQ85NfctYCun2o,16562584
+fourcipp/config/config.yaml,sha256=n2c2a6E4HKfAdNWOQz1kLUuf5p4NLxIddaAi2t5eM38,460
+fourcipp/legacy_io/__init__.py,sha256=L3MWW-WjPbPAJVX8Z0Uheftn0dRPnqNnSBic3uloFhI,5750
+fourcipp/legacy_io/element.py,sha256=rP8F-m-8ZCwCxtV_OASvvLeNYr01zsmgZsDZSJ_G1gY,3977
+fourcipp/legacy_io/inline_dat.py,sha256=tudLWZlCq6JZgSc1WhzNw233XNWxkmEQ7oGDd2UEgB4,6941
+fourcipp/legacy_io/node.py,sha256=e7m0W7dai_b1XgaqD37k3QS44ySCas3HetmyTLS9_78,3522
+fourcipp/legacy_io/node_topology.py,sha256=hqGGzhyNhFX-BMW8SzztfzM8zoZLLltVScMv-p4hDH0,5394
+fourcipp/legacy_io/particle.py,sha256=8LoRsyKVfhl5Qf_EoO8vLmbH0QSpB_Nho464ifkHAZc,2172
+fourcipp/utils/__init__.py,sha256=ccdlf4taJ0mKLg_ru8ilXEa72PoO9N2UIxHNHDEtQmY,1151
+fourcipp/utils/cli.py,sha256=Tn9jx0KhC421zv-DMpqNU2hpb6fyi4-r4qV17f-ts4Y,5807
+fourcipp/utils/configuration.py,sha256=HZY_dZWjP8Tr7dPAPLRD6xBkZ8LvkQOKVKSKf8ndVJg,7828
+fourcipp/utils/converter.py,sha256=D40YQ96WqPEEpB7fwAB5XC2v-jRki4v1sIJ-ngO08nU,5194
+fourcipp/utils/dict_utils.py,sha256=uC0uaBNP3Wh2v3kFy9JHnAYARMukAN4cl40pmiBT13Y,12891
+fourcipp/utils/metadata.py,sha256=TxKmpx-Mb3VeR6okUUtHDo0TwGcKxpyCtCExzphFEPU,30906
+fourcipp/utils/not_set.py,sha256=NHf0UXDmTuZfvfnIIgkkx4EohxRsN4MVUHUpt7VOnaQ,2433
+fourcipp/utils/type_hinting.py,sha256=izPEhbMdmhrIBamCLqqF_6iDZW-w7a8kplUugbQILyw,1714
+fourcipp/utils/validation.py,sha256=FejHOj1MddaU7gEpMN-f8Mz3rYjflakd1qcsKnctHqA,5292
+fourcipp/utils/yaml_io.py,sha256=jPgVnxE858XTpDC6BVhfbbljQegL58zc3u2VPYCTvGE,5771
+fourcipp-1.50.0.dist-info/licenses/LICENSE,sha256=lkSOHdH9IZ8c3Vnz0fFjqls1cRlmLADBP8QEIwUlH3o,1082
+fourcipp-1.50.0.dist-info/METADATA,sha256=a9fv6RT6tkicDZqjeDFOyxwLV0Uwkd4YA8Z5pq-dkFg,7960
+fourcipp-1.50.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fourcipp-1.50.0.dist-info/entry_points.txt,sha256=44XBG4bwhuq1EwOZ0U055HYP8_qN6_d30ecVsa5Igng,53
+fourcipp-1.50.0.dist-info/top_level.txt,sha256=oZ6jgFFmvi157VwGUEFuKT3D8oS5mOkpOVx8zZURZrQ,9
+fourcipp-1.50.0.dist-info/RECORD,,

fourcipp-1.50.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fourcipp-1.50.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fourcipp = fourcipp.utils.cli:main

fourcipp-1.50.0.dist-info/licenses/LICENSE

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

fourcipp-1.50.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fourcipp