Metadata-Version: 2.1
Name: serpentTools
Version: 0.10.0
Summary: A suite of parsers designed to make interacting with Serpent output files simple, scriptable, and flawless
Maintainer: Dan Kotlyar, Drew Johnson
License: MIT License
        
        Copyright (c) 2017-2023 Serpent-Tools Developers, GTRC
        
        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://github.com/CORE-GATECH-GROUP/serpent-tools
Project-URL: Bug Tracker, https://github.com/CORE-GATECH-GROUP/serpent-tools/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: <3.12,>=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy >=1.16.0
Requires-Dist: matplotlib !=3.3.4,>=2.2.3
Requires-Dist: pyyaml >=5.1.1
Provides-Extra: ci
Requires-Dist: jupyter ; extra == 'ci'
Provides-Extra: extras
Requires-Dist: pandas >1 ; extra == 'extras'
Requires-Dist: scipy ; extra == 'extras'
Provides-Extra: test
Requires-Dist: pytest >=6 ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: coverage ; extra == 'test'

=============
serpent-tools
=============

.. image:: https://readthedocs.org/projects/serpent-tools/badge/?version=latest
    :target: http://serpent-tools.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://badge.fury.io/py/serpentTools.svg
   :target: https://badge.fury.io/py/serpentTools
   :alt: PyPi badge

.. image:: https://zenodo.org/badge/DOI/10.1080/00295639.2020.1723992.svg
   :target: https://doi.org/10.1080/00295639.2020.1723992
   :alt: Nuclear Science and Engineering 10.1080/00295639.2020.1723992

A suite of parsers designed to make interacting with
``SERPENT`` [1]_ output files simple and flawless.

The ``SERPENT`` Monte Carlo code
is developed by VTT Technical Research Centre of Finland, Ltd.
More information, including distribution and licensing of ``SERPENT`` can be
found at `<http://montecarlo.vtt.fi>`_

Installation
============

``serpentTools`` can be installed with ``pip`` using::

   $ pip install serpentTools

For more detailed instructions, including operating-system specific
instructions and building from source, see
`Installation Guide <http://serpent-tools.readthedocs.io/en/latest/install.html>`_.

Issues
======

If you have issues installing the project, find a bug, or want to add a feature,
the `GitHub issue page <https://github.com/CORE-GATECH-GROUP/serpent-tools/issues>`_
is the best place to do that.

Support
=======

The development of ``serpentTools`` is supported by the following organizations:

* `USNC-Tech <https://usnc.com/space>`_

References
==========

The Annals of Nuclear Energy article should be cited for all work
using ``SERPENT``. If you are using this project, please considering
citing with

* Andrew Johnson, Dan Kotlyar, Stefano Terlizzi, and Gavin Ridley,
  "`serpentTools: A Python Package for Expediting Analysis with
  Serpent <https://doi.org/10.1080/00295639.2020.1723992>`_,"
  *Nuc. Sci. Eng*, 2020, 194, 1016-1024

Also, let us know if you publish work using this package! We try and
keep an up-to-date list of works using serpentTools [2]_, and would be
happy to include more.

.. [1] Leppanen, J. et al. (2015) "The Serpent Monte Carlo code: Status,
    development and applications in 2013." Ann. Nucl. Energy, `82 (2015) 142-150
    <http://www.sciencedirect.com/science/article/pii/S0306454914004095>`_

.. [2] https://serpent-tools.readthedocs.io/en/latest/publications.html
