Introduction

Welcome to KDSource’s documentation!

KDSource is a tool for Monte Carlo particle sources generation using Kernel Density Estimation.

KDSource assists Monte Carlo beams and shielding calculations, improving tally results in difficult problems. It allows to model big systems (e.g.: investigation reactor guides hall) through spatial or temporal coupling of different simulations in different transport codes, implementing as well variance reduction.

It processes particle lists recorded as output of a simulation (e.g.: passing thru a window), to be used as input in another one. It estimates density distribution in energy, position and direction by means of Kernel Density Estimation (KDE) technique, allowing visualizing it as well as using it to produce new particles (artificial, but with the same estimated density). This allows to increase the number of source particles in the second simulation, improving its statistics (variance reduction).

Note

Check out the Other less documented examples section for further information, as well as the Tutorial and the Installation instructions.

This project is under active development.

Contents

• Introduction
• Installation
  • Linux and Mac
  • Windows
• Tutorial
  • Install KDSource
  • Generate synthetic data
  • Create and optimize KDSource
    • Create KDSource
    • Optimize bandwidth
  • Save KDSource model
  • Generate particles
  • Create plots
    • Energy / lethargy plots
    • Position plots
    • Direction plots
• Examples
  • Using a KDSource as source component in McStas
    • Using this template
      • About the instrument file
      • Understanding the exe_McStas.sh
  • Other less documented examples
• API Reference
  • kdsource Python API
    • kdsource.kdsource module
    • kdsource.plist module
    • kdsource.geom module
      • Metric
        • Metric.__init__()
        • Metric.transform()
        • Metric.inverse_transform()
        • Metric.jac()
        • Metric.mean()
        • Metric.std()
        • Metric.save()
        • Metric.load()
        • Metric.__dict__
        • Metric.__module__
        • Metric.__weakref__
      • Geometry
        • Geometry.__init__()
        • Geometry.transform()
        • Geometry.inverse_transform()
        • Geometry.jac()
        • Geometry.mean()
        • Geometry.std()
        • Geometry.save()
        • Geometry.load()
        • Geometry.__module__
      • Energy
        • Energy.__init__()
        • Energy.load()
        • Energy.__module__
      • Lethargy
        • Lethargy.__init__()
        • Lethargy.transform()
        • Lethargy.inverse_transform()
        • Lethargy.jac()
        • Lethargy.save()
        • Lethargy.load()
        • Lethargy.__module__
      • Time
        • Time.__init__()
        • Time.load()
        • Time.__module__
      • Decade
        • Decade.__init__()
        • Decade.transform()
        • Decade.inverse_transform()
        • Decade.jac()
        • Decade.load()
        • Decade.__module__
      • Vol
        • Vol.__init__()
        • Vol.save()
        • Vol.load()
        • Vol.__module__
      • SurfXY
        • SurfXY.__init__()
        • SurfXY.transform()
        • SurfXY.inverse_transform()
        • SurfXY.save()
        • SurfXY.load()
        • SurfXY.__module__
      • SurfR
        • SurfR.__init__()
        • SurfR.transform()
        • SurfR.inverse_transform()
        • SurfR.save()
        • SurfR.jac()
        • SurfR.load()
        • SurfR.__module__
      • SurfR2
        • SurfR2.__init__()
        • SurfR2.transform()
        • SurfR2.inverse_transform()
        • SurfR2.save()
        • SurfR2.jac()
        • SurfR2.load()
        • SurfR2.__module__
      • SurfCircle
        • SurfCircle.__init__()
        • SurfCircle.transform()
        • SurfCircle.inverse_transform()
        • SurfCircle.save()
        • SurfCircle.load()
        • SurfCircle.__module__
      • Guide
        • Guide.__init__()
        • Guide.transform()
        • Guide.inverse_transform()
        • Guide.save()
        • Guide.load()
        • Guide.__module__
      • Isotrop
        • Isotrop.__init__()
        • Isotrop.mean()
        • Isotrop.std()
        • Isotrop.save()
        • Isotrop.load()
        • Isotrop.__module__
      • Polar
        • Polar.__init__()
        • Polar.transform()
        • Polar.inverse_transform()
        • Polar.jac()
        • Polar.load()
        • Polar.__module__
      • PolarMu
        • PolarMu.__init__()
        • PolarMu.transform()
        • PolarMu.inverse_transform()
        • PolarMu.load()
        • PolarMu.__module__
      • GeomFlat()
      • GeomFlatTemp()
      • GeomGuide()
      • GeomActiv()
    • kdsource.kde module
    • kdsource.stats module
    • kdsource.summary module
    • kdsource.tally module
    • kdsource.utils module
  • kdsource C API
    • KDSource and MultiSource structures
    • PList structure
    • Geometry and Metric structures
    • General utilities
  • kdtool Command Line Tool
    • Resample
    • Templates
    • Beamtest
    • MCPL access