Metadata-Version: 2.1
Name: pyCFS
Version: 0.1.9
Summary: Python library for automating and data handling tasks for openCFS.
Author-email: IGTE <igte.gitlab@gmail.com>, Eniz Mušeljić <eniz.m@outlook.com>, Andreas Wurzinger <andreas.wurzinger@tugraz.at>, Patrick Heidegger <patrick.heidegger@tugraz.at>
License: MIT License
        
        Copyright (c) 2024 Verein zur Förderung der Software openCFS
        
        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: Homepage, https://opencfs.org/
Project-URL: Documentation, https://opencfs.gitlab.io/pycfs/
Project-URL: Repository, https://gitlab.com/openCFS/pycfs
Project-URL: Issues, https://gitlab.com/openCFS/pycfs/-/issues
Project-URL: Changelog, https://gitlab.com/openCFS/pycfs/-/blob/main/Changelog.md
Keywords: automation,simulation,optimization,opencfs,data processing
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Natural Language :: English
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy==1.26.4
Requires-Dist: matplotlib==3.8.3
Requires-Dist: typing==3.7.4.3
Requires-Dist: typed-argument-parser==1.9.0
Requires-Dist: tqdm==4.66.2
Requires-Dist: h5py==3.10.0
Requires-Dist: numba==0.61.0
Requires-Dist: netCDF4>=1.7.2
Requires-Dist: scipy>=1.10.1
Requires-Dist: scikit-spatial>=7.0.0
Requires-Dist: pyuff==2.1
Requires-Dist: stl-reader==0.2.2
Provides-Extra: ansys
Requires-Dist: ansys-dpf-core>=0.10.0; extra == "ansys"
Requires-Dist: pyvista>=0.43.1; extra == "ansys"
Provides-Extra: vtk
Requires-Dist: vtk>=9.3.0; extra == "vtk"
Provides-Extra: all
Requires-Dist: vtk>=9.3.0; extra == "all"
Requires-Dist: ansys-dpf-core>=0.10.0; extra == "all"
Requires-Dist: pyvista>=0.43.1; extra == "all"
Requires-Dist: pydmd>=2025.6.1; extra == "all"
Provides-Extra: dev
Requires-Dist: sphinx==7.2.6; extra == "dev"
Requires-Dist: myst-parser==2.0.0; extra == "dev"
Requires-Dist: sphinx-book-theme==1.1.2; extra == "dev"
Requires-Dist: pytest==8.0.2; extra == "dev"
Requires-Dist: pytest-cov==4.1.0; extra == "dev"
Requires-Dist: black==24.2.0; extra == "dev"
Requires-Dist: mypy==1.8.0; extra == "dev"
Requires-Dist: flake8==7.0.0; extra == "dev"
Requires-Dist: twine==5.0.0; extra == "dev"
Requires-Dist: build==1.1.1; extra == "dev"
Requires-Dist: pandas>=2.0.3; extra == "dev"
Provides-Extra: dmd
Requires-Dist: pydmd>=2025.6.1; extra == "dmd"

# ![pyCFS](docs/source/_static/art/pyCFS_logo.svg)

[![PyPi Version](https://img.shields.io/pypi/v/pycfs.svg?style=flat-square)](https://pypi.org/project/pycfs/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pycfs.svg?style=flat-square)](https://pypi.org/project/pycfs/)
[![DOI](https://zenodo.org/badge/DOI/10.48550/arXiv.2405.03437.svg?style=flat-square)](https://doi.org/10.48550/arXiv.2405.03437)
[![GitLab stars](https://img.shields.io/gitlab/stars/opencfs/pycfs.svg?style=flat-square&logo=gitlab&label=Stars&logoColor=white)](https://gitlab.com/opencfs/pycfs)
[![Downloads](https://pepy.tech/badge/pycfs/month?style=flat-square)](https://pepy.tech/project/pycfs)

[![pipeline status](https://img.shields.io/gitlab/pipeline-status/opencfs/pycfs?style=flat-square)](https://gitlab.com/opencfs/pycfs/-/pipelines)
[![coverage](https://gitlab.com/opencfs/pycfs/badges/main/coverage.svg)](https://gitlab.com/opencfs/pycfs/-/jobs)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)

Python library for automating and data handling tasks for openCFS. Available on [PyPI](https://pypi.org/project/pyCFS/).

For more information, please visit the [documentation page](https://opencfs.gitlab.io/pycfs/index.html).

### Included submodules:

- `pyCFS`: Automation library
- `pyCFS.application`: Library of application-focused python scripts.
- `pyCFS.data`: Data processing framework for CFS type hdf5 file format.
- `pyCFS.topt`: Topology Optimization with openCFS.

## Installation

PyCFS can be installed via pip. The recommended way is to use a virtual environment or conda environment. Install with

```bash
python -m pip install --upgrade pycfs
```

For more information see the [installation guide](https://opencfs.gitlab.io/pycfs/installation.html) in the documentation.

## Contributing

For a developer install see the [developer installation guide](https://opencfs.gitlab.io/pycfs/installation.html#developer-install). 
See the [contribution guidelines](https://opencfs.gitlab.io/pycfs/dev_source/dev_notes_main.html) in the documentation on how to contribute to the project.
