Metadata-Version: 2.4
Name: kokiy
Version: 1.0.0
Summary: Utilities to work on 2D and 3D structured grids
Author-email: CoopTeam-CERFACS <coop@cerfacs.fr>
License: MIT License
        
        Copyright (c) 2021 Cerfacs/COOP Team
        
        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://gitlab.com/cerfacs/kokiy
Project-URL: Documentation, https://kokiy.readthedocs.io/en/latest/
Project-URL: Issues, https://gitlab.com/cerfacs/kokiy/-/issues
Project-URL: Changelog, https://gitlab.com/cerfacs/kokiy/-/blob/master/CHANGELOG.md
Keywords: shell,mesh,scientific computing,finite elements,cfd
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.md
Requires-Dist: numpy>=2.0
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: arnica
Requires-Dist: meshio
Requires-Dist: yamio
Requires-Dist: cloud2cloud
Provides-Extra: docs
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: nbsphinx==0.8.6; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: jupyter-sphinx; extra == "docs"
Requires-Dist: pyvista; extra == "docs"
Requires-Dist: ipygany; extra == "docs"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: h5py; extra == "tests"
Requires-Dist: pyvista; extra == "tests"
Requires-Dist: pytest-coverage; extra == "tests"
Requires-Dist: pytest-allclose; extra == "tests"
Dynamic: license-file

``kokiy`` contains utilities to work on 2D and 3D structured grids. Grids can be, among others, cartesian planes (``CartShell``) or axi-cylindrical extrusions from x-r splines (``AxiShell``). ``ThickShell`` are 3D shells built by extruding any of the available 2d objects. Check out the API reference for an extensive list of all available geometries.


Main features include:

* create 2D and 3D structured grids (including axi-cylindrical objects)
* interpolate a solution
* operate (e.g. average) a solution over a direction
* dump shells for fields visualization in `ParaView <https://www.paraview.org/>`_
* export mesh in any format available in `yamio <https://pypi.org/project/yamio/>`_ (e.g. ``hip``-friendly ``.hdf5``, ``xdfm``, ``dolfin-xml``)
* export ``.geo`` files for visualization with `tiny-3d-engine <https://pypi.org/project/tiny-3d-engine/>`_



Installation
------------

Install with


.. code-block:: bash

    pip install kokiy
