https://github.com/CORE-GATECH-GROUP/serpent-tools

A suite of parsers designed to make interacting with SERPENT output files simple and flawless
https://github.com/CORE-GATECH-GROUP/serpent-tools

monte-carlo nuclear-engineering python reactor-physics serpent

Last synced: about 1 month ago
JSON representation

A suite of parsers designed to make interacting with SERPENT output files simple and flawless

• Host: GitHub
• URL: https://github.com/CORE-GATECH-GROUP/serpent-tools
• Owner: CORE-GATECH-GROUP
• License: mit
• Created: 2017-09-07T21:19:39.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T09:15:38.000Z (3 months ago)
• Last Synced: 2024-07-31T23:37:38.389Z (about 1 month ago)
• Topics: monte-carlo, nuclear-engineering, python, reactor-physics, serpent
• Language: Python
• Homepage: http://serpent-tools.readthedocs.io/en/latest/
• Size: 12.5 MB
• Stars: 51
• Watchers: 6
• Forks: 32
• Open Issues: 33
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-nuclear - serpentTools - based tool suite for Serpent (Particle Transport / Related Tools)

README

        
=============

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 ``_

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 `_.

Alternatively, use ``conda`` with::

  $ conda install -c conda-forge serpentTools

Issues

======

If you have issues installing the project, find a bug, or want to add a feature,

the `GitHub issue page `_

is the best place to do that.

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 `_,"

  *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

    `_

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