Metadata-Version: 2.1
Name: mckit-meshes
Version: 0.1.5a0
Summary: Python tools to work with MCNP meshtallies and weight meshes.
Home-page: https://github.com/MC-kit/mckit-meshes
License: MIT
Keywords: mesh,weights,variance reduction
Author: dvp2015
Author-email: dmitri_portnov@yahoo.com
Requires-Python: >=3.9,<3.13
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
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: Topic :: Scientific/Engineering :: Physics
Requires-Dist: click (>=8.0.1)
Requires-Dist: loguru (>=0.6.0)
Requires-Dist: numpy (>=1.24.2)
Requires-Dist: openpyxl (>=3.0.9)
Requires-Dist: pandas (>=2.0.0)
Requires-Dist: pyevtk (>=1.4.1)
Requires-Dist: toolz (>=0.11.2)
Project-URL: Chnagelog, https://github.com/MC-kit/mckit-meshes/releases
Project-URL: Repository, https://github.com/MC-kit/mckit-meshes
Description-Content-Type: text/x-rst

==============================================================================
*mckit_meshes*: to work with MCNP mesh tallies and weight meshes
==============================================================================



|Maintained| |License| |Versions| |PyPI| |Docs|

.. contents::


Note:
    This document is in progress.

Description
-----------

The module implements methods to read and manipulate (merge, inverse, scale, etc.)
MCNP mesh tallies and weight meshes.

.. TODO dvp: apply FISPACT v.5 API and describe here.


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

.. TODO dvp: check and report all possible ways to install (pip, poetry)


Examples
--------

.. TODO

Contributing
------------

.. image:: https://github.com/MC-kit/mckit-meshes/workflows/Tests/badge.svg
   :target: https://github.com/MC-kit/mckit-meshes/actions?workflow=Tests
   :alt: Tests
.. image:: https://codecov.io/gh/MC-kit/mckit-meshes/branch/master/graph/badge.svg?token=wlqoa368k8
  :target: https://codecov.io/gh/MC-kit/mckit-meshes
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
   :target: https://pycqa.github.io/isort/
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit

References
----------

.. TODO dvp: add references to iww-gvr, mckit and used libraries:  poetry, xarray etc


.. Substitutions

.. |Maintained| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
   :target: https://github.com/MC-kit/mckit-meshes/graphs/commit-activity
.. |Tests| image:: https://github.com/MC-kit/mckit-meshes/workflows/Tests/badge.svg
   :target: https://github.com/MC-kit/mckit-meshes/actions?workflow=Tests
   :alt: Tests
.. |License| image:: https://img.shields.io/github/license/MC-kit/mckit-meshes
   :target: https://github.com/MC-kit/mckit-meshes
.. |Versions| image:: https://img.shields.io/pypi/pyversions/mckit-meshes
   :alt: PyPI - Python Version
.. |PyPI| image:: https://img.shields.io/pypi/v/mckit-meshes
   :target: https://pypi.org/project/mckit-meshes/
   :alt: PyPI
.. |Docs| image:: https://readthedocs.org/projects/mckit-meshes/badge/?version=latest
   :target: https://mckit_meshes.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

