fudge Package¶
Warning
THE fudge, __doc__, fudgeDefaults, AND fudgeParameters MODULES CORRESPOND TO LEGACY FUDGE
fudge
Package¶
Fudge is a python package which allows one to view, plot and modify LLNL’s evaluated nuclear data, and use LLNL’s processing codes that convert the evaluated data into processed data. Processed data is evaluatated nuclear transport data that has been converted into a format used by the deterministic (libndf.a) and and Monte Carlo (MCAPM) transport libraries. The deterministic library reads data from the ndf files (ndf1, ndf2, etc.) and the Monte Carlo library reads data from the mcf files (mcf1.pdb, mcf2.pdb, etc.).
Getting at fudge’s python scripts.¶
To use fudge, one must add the location of the fudge scripts to the environment variable PYTHONPATH. (PYTHONPATH is the environment variable used by python when searching for imported python modules (files). On LLNL’s computing system (LC) this would look something like,
export PYTHONPATH=$PYTHONPATH:/usr/apps/fudge/current/Src
for the bash shell.
Alternatively, one can add the following lines near the top of a python script (or type them at the prompt)
>>> import sys
>>> sys.path.append( "/usr/apps/fudge/current/Src" )
Other environment variables.¶
Besides PYTHONPATH, there are four other environment variables used by fudge. They are:
FUDGEPATH Where fudges expects all platform dependent (e.g., binary) files to be.
ENDLPATH If defined, this is used to initialize fudgeDefaults.ENDL_DATABASE_DIR
MCFPATH If defined, this is used to initialize fudgeDefaults.MCF_DATABASE_DIR
NDFPATH If defined, this is used to initialize fudgeDefaults.NDF_DATABASE_DIR
If the environment variable FUDGEPATH is not set, fudge sets it to fudgeDefaults.DefaultFudgePath. For more information on ENDL_DATABASE_DIR, MCF_DATABASE_DIR and NDF_DATABASE_DIR set the documentation for the fudgeDefaults module.
Thus, there are three ways to set the variables fudge uses to search for files.
- Do nothing and fudge will use the variables in the module fudgeDefaults.
- Set the appropriate environment variable (i.e., FUDGEPATH, ENDLPATH, MCFPATH or NDFPATH).
- Set variables in the fudgeDefaults module. For example,
>>> import fudgeDefaults
>>> fudgeDefaults.NDF_DATABASE_DIR = /my/personal/database/processed
Reading fudge’s documentation.¶
In general, one should first instantiate an endlProject class object and work from it. For example the beginning of a fudge session may look like,
>>> from fudge import *
>>> project = endlProject( database = "endl99", workDir = "tmp" )
It is therefore important to read the documentation on the module endlProject; and in particular, the class endlProject. Also, see the module fudgeDefaults for default locations fudge searches to find evaluated and processed data files, and where it searches to find platform dependent files (e.g., executable files).
__doc__
Module¶
Fudge is a python package which allows one to view, plot and modify LLNL’s evaluated nuclear data, and use LLNL’s processing codes that convert the evaluated data into processed data. Processed data is evaluatated nuclear transport data that has been converted into a format used by the deterministic (libndf.a) and and Monte Carlo (MCAPM) transport libraries. The deterministic library reads data from the ndf files (ndf1, ndf2, etc.) and the Monte Carlo library reads data from the mcf files (mcf1.pdb, mcf2.pdb, etc.).
Getting at fudge’s python scripts.¶
To use fudge, one must add the location of the fudge scripts to the environment variable PYTHONPATH. (PYTHONPATH is the environment variable used by python when searching for imported python modules (files). On LLNL’s computing system (LC) this would look something like,
export PYTHONPATH=$PYTHONPATH:/usr/apps/fudge/current/Src
for the bash shell.
Alternatively, one can add the following lines near the top of a python script (or type them at the prompt)
>>> import sys
>>> sys.path.append( "/usr/apps/fudge/current/Src" )
Other environment variables.¶
Besides PYTHONPATH, there are four other environment variables used by fudge. They are:
FUDGEPATH Where fudges expects all platform dependent (e.g., binary) files to be.
ENDLPATH If defined, this is used to initialize fudgeDefaults.ENDL_DATABASE_DIR
MCFPATH If defined, this is used to initialize fudgeDefaults.MCF_DATABASE_DIR
NDFPATH If defined, this is used to initialize fudgeDefaults.NDF_DATABASE_DIR
If the environment variable FUDGEPATH is not set, fudge sets it to fudgeDefaults.DefaultFudgePath. For more information on ENDL_DATABASE_DIR, MCF_DATABASE_DIR and NDF_DATABASE_DIR set the documentation for the fudgeDefaults module.
Thus, there are three ways to set the variables fudge uses to search for files.
- Do nothing and fudge will use the variables in the module fudgeDefaults.
- Set the appropriate environment variable (i.e., FUDGEPATH, ENDLPATH, MCFPATH or NDFPATH).
- Set variables in the fudgeDefaults module. For example,
>>> import fudgeDefaults
>>> fudgeDefaults.NDF_DATABASE_DIR = /my/personal/database/processed
Reading fudge’s documentation.¶
In general, one should first instantiate an endlProject class object and work from it. For example the beginning of a fudge session may look like,
>>> from fudge import *
>>> project = endlProject( database = "endl99", workDir = "tmp" )
It is therefore important to read the documentation on the module endlProject; and in particular, the class endlProject. Also, see the module fudgeDefaults for default locations fudge searches to find evaluated and processed data files, and where it searches to find platform dependent files (e.g., executable files).
fudgeDefaults
Module¶
This module contains default parameters used by fudge.
Variables:
NeedPythonPathToFudge Fudge attempts to determine if the location of fudge is included
in python's search path (e.g., locations set by PYTHONPATH).
If fudge determines that it is not in the python search path then
it adds its location - as given by DefaultFudgePath/Src - to the
python search path. However, if NeedPythonPathToFudge is false
fudge will not add its location to the python search path.
DefaultFudgePath Location where fudge scripts and binaries can be found.
Scripts are to be in DefaultFudgePath/Src.
Binaries are to be in DefaultFudgePath/bin.
NUCLEAR_DATABASE_DIR Location of the nuclear data root.
ENDL_DATABASE_DIR Location of the default evaluated databases.
TRANSLATED_DATABASE_DIR Location of the translated database
ENDL_DEFAULT_DATABASE Default evaluated database in ENDL_DATABASE_DIR.
This can be set with the envirnoment varialbe ENDLPATH.
MCF_DATABASE_DIR Location of the default mcf (Monte Carlo transport) processed files.
This can be set with the envirnoment varialbe MCFPATH.
NDF_DATABASE_DIR Location of the default ndf (deterministic transport) processed files.
This can be set with the envirnoment varialbe NDFPATH.
Also see the description of the variables PYTHONPATH and FUDGEPATH in the module fudge.py. The module fudge.py describes the proper procedure to follow to override these parameters.
fudgeParameters
Module¶
This module contains the parameters VerboseMode and ReadOnly.
Subpackages¶
- Core library
- Subpackages
- fudge.core.math package
- Subpackages
- fudge.core.math.test package
- fudge.core.math.xData package
- Subpackages
- Submodules
- fudge.core.math.xData.LegendreSeries module
- fudge.core.math.xData.V_W_XYs module
- fudge.core.math.xData.W_XYs module
- fudge.core.math.xData.XYs module
- fudge.core.math.xData.Ys module
- fudge.core.math.xData.axes module
- fudge.core.math.xData.polynomial module
- fudge.core.math.xData.regions module
- Module contents
- Submodules
- fudge.core.math.fudge2dGrouping module
- fudge.core.math.fudgemath module
- fudge.core.math.linearAlgebra module
- fudge.core.math.matrix module
- fudge.core.math.miscellaneous module
- fudge.core.math.pointwiseXY module
- fudge.core.math.table module
- Module contents
- Subpackages
- fudge.core.utilities package
- Subpackages
- Submodules
- fudge.core.utilities.abundance module
- fudge.core.utilities.argparse module
- fudge.core.utilities.brb module
- fudge.core.utilities.fudgeExceptions module
- fudge.core.utilities.fudgeFileMisc module
- fudge.core.utilities.fudgeZA module
- fudge.core.utilities.pyparsing module
- fudge.core.utilities.reactionStrings module
- fudge.core.utilities.subprocessing module
- fudge.core.utilities.times module
- fudge.core.utilities.xmlNode module
- Module contents
- fudge.core.math package
- Submodules
- fudge.core.ancestry module
- fudge.core.fudgemisc module
- Module contents
- Subpackages
- GNDS hierarchy
- Subpackages
- fudge.gnds.channelData package
- fudge.gnds.covariances package
- Submodules
- fudge.gnds.covariances.base module
- fudge.gnds.covariances.covarianceSuite module
- fudge.gnds.covariances.distributions module
- fudge.gnds.covariances.mixed module
- fudge.gnds.covariances.modelParameters module
- fudge.gnds.covariances.section module
- fudge.gnds.covariances.summed module
- fudge.gnds.covariances.tokens module
- Module contents
- fudge.gnds.productData package
- Subpackages
- fudge.gnds.productData.distributions package
- Subpackages
- Submodules
- fudge.gnds.productData.distributions.Legendre module
- fudge.gnds.productData.distributions.angular module
- fudge.gnds.productData.distributions.angularEnergy module
- fudge.gnds.productData.distributions.base module
- fudge.gnds.productData.distributions.energy module
- fudge.gnds.productData.distributions.energyAngular module
- fudge.gnds.productData.distributions.miscellaneous module
- fudge.gnds.productData.distributions.photonScattering module
- fudge.gnds.productData.distributions.uncorrelated module
- Module contents
- fudge.gnds.productData.distributions package
- Submodules
- fudge.gnds.productData.base module
- fudge.gnds.productData.energyDeposition module
- fudge.gnds.productData.momentumDeposition module
- fudge.gnds.productData.multiplicity module
- Module contents
- Subpackages
- fudge.gnds.reactionData package
- fudge.gnds.reactions package
- fudge.gnds.test package
- Submodules
- fudge.gnds.alias module
- fudge.gnds.baseClasses module
- fudge.gnds.channels module
- fudge.gnds.documentation module
- fudge.gnds.link module
- fudge.gnds.miscellaneous module
- fudge.gnds.product module
- fudge.gnds.reactionSuite module
- fudge.gnds.referredData module
- fudge.gnds.resonances module
- fudge.gnds.thermalScattering module
- fudge.gnds.tokens module
- fudge.gnds.version module
- fudge.gnds.warning module
- fudge.gnds.xParticle module
- fudge.gnds.xParticleList module
- Module contents
- Subpackages
- Legacy data support
- Subpackages
- fudge.legacy.converting package
- Subpackages
- Submodules
- fudge.legacy.converting.endfFileToGNDS module
- fudge.legacy.converting.endfFormats module
- fudge.legacy.converting.endfThermScattToGNDS module
- fudge.legacy.converting.endf_endl module
- fudge.legacy.converting.endlToGNDS module
- fudge.legacy.converting.gndsToENDF6 module
- fudge.legacy.converting.toGNDSMisc module
- Module contents
- Subpackages
- fudge.legacy.endl package
- Subpackages
- Submodules
- fudge.legacy.endl.bdfls module
- fudge.legacy.endl.endl1dmathClasses module
- fudge.legacy.endl.endl1dmathmisc module
- fudge.legacy.endl.endl2 module
- fudge.legacy.endl.endl2dmathClasses module
- fudge.legacy.endl.endl2dmathmisc module
- fudge.legacy.endl.endl3dmathClasses module
- fudge.legacy.endl.endl3dmathmisc module
- fudge.legacy.endl.endl4dmathClasses module
- fudge.legacy.endl.endl4dmathmisc module
- fudge.legacy.endl.endlFile module
- fudge.legacy.endl.endlIClasses module
- fudge.legacy.endl.endlIClassesParameters module
- fudge.legacy.endl.endlNd module
- fudge.legacy.endl.endlParameters module
- fudge.legacy.endl.endlProject module
- fudge.legacy.endl.endlReactionParameters module
- fudge.legacy.endl.endlSplit module
- fudge.legacy.endl.endlZA module
- fudge.legacy.endl.endl_C module
- fudge.legacy.endl.endl_I module
- fudge.legacy.endl.endl_Z module
- fudge.legacy.endl.endl_y module
- fudge.legacy.endl.endlmath module
- fudge.legacy.endl.endlmisc module
- fudge.legacy.endl.endltdf module
- fudge.legacy.endl.fudgeDocumentationFile module
- fudge.legacy.endl.fudgemiscLegacy module
- fudge.legacy.endl.largeAngleCoulombScattering_generator module
- fudge.legacy.endl.tdf module
- Module contents
- fudge.legacy.converting package
- Module contents
- Subpackages
- Particle properties
- Processing support
- Subpackages
- fudge.processing.deterministic package
- fudge.processing.montecarlo package
- fudge.processing.resonances package
- Submodules
- fudge.processing.miscellaneous module
- fudge.processing.processingInfo module
- Module contents
- Subpackages
- Structure data
- Visualization
- Subpackages
- fudge.vis.gnuplot package
- Submodules
- fudge.vis.gnuplot.endl2dplot module
- fudge.vis.gnuplot.endl3dplot module
- fudge.vis.gnuplot.endl4dplot module
- fudge.vis.gnuplot.fudge2dMultiPlot module
- fudge.vis.gnuplot.fudge2dMultiPlotClass module
- fudge.vis.gnuplot.fudge3dMultiPlot module
- fudge.vis.gnuplot.fudgeMultiPlots module
- fudge.vis.gnuplot.fudgeNdMultiPlotMisc module
- fudge.vis.gnuplot.plotbase module
- Module contents
- fudge.vis.matplotlib package
- fudge.vis.gnuplot package
- Module contents
- Subpackages
- C extensions for low-level numerics