BasicTools.Helpers package

Helpers classes and functions

Please read the help for each individual module.

Submodules

• BasicTools.Helpers.BaseOutputObject module
  • BaseOutputObject
    • BaseOutputObject.GetDiffTime()
    • BaseOutputObject.GetVerboseLevel()
    • BaseOutputObject.InDebugMode()
    • BaseOutputObject.IsGlobalDebugMode()
    • BaseOutputObject.Print()
    • BaseOutputObject.Print2()
    • BaseOutputObject.PrintDebug()
    • BaseOutputObject.PrintError()
    • BaseOutputObject.PrintInternal()
    • BaseOutputObject.PrintProgress()
    • BaseOutputObject.PrintVerbose()
    • BaseOutputObject.RETURN_FAIL
    • BaseOutputObject.RETURN_FAIL_EXTERNAL_TOOL
    • BaseOutputObject.RETURN_SUCCESS
    • BaseOutputObject.SetGlobalDebugMode()
    • BaseOutputObject.SetInstanceDebugMode()
    • BaseOutputObject.SetVerboseLevel()
  • CheckIntegrity()
  • ResetStartTime()
  • SetUseDifferentialTime()
  • froze_it()
• BasicTools.Helpers.CPU module
  • CPU
    • CPU.cpudispo
  • CheckIntegrity()
  • GetNumberOfAvailableCpus()
  • SetNumberOfThreadsPerInstance()
• BasicTools.Helpers.Cache module
  • CachedResultDecorator()
  • CheckIntegrity()
  • GetFunctionWithCache()
  • HashFunction()
• BasicTools.Helpers.Factory module
  • CheckIntegrity()
  • Factory
    • Factory.AllEntries()
    • Factory.Create()
    • Factory.GetAvailablesFor()
    • Factory.GetClass()
    • Factory.GetConstructor()
    • Factory.PrintAvailable()
    • Factory.RegisterClass()
    • Factory.keys()
• BasicTools.Helpers.Interpolation module
  • BinarySearch()
  • BinarySearchVectorized()
  • CheckIntegrity()
  • PieceWiseLinearInterpolation()
  • PieceWiseLinearInterpolationVectorized()
  • PieceWiseLinearInterpolationVectorizedWithMap()
  • PieceWiseLinearInterpolationWithMap()
• BasicTools.Helpers.MPIInterface module
  • CheckIntegrity()
  • MPIInterface
    • MPIInterface.IsParallel()
    • MPIInterface.Rank()
    • MPIInterface.Size()
• BasicTools.Helpers.ParserHelper module
  • AddCommonConstants()
  • AddToGlobalDictionary()
  • ApplyGlobalDictionary()
  • CheckIntegrity()
  • LocalVariables
    • LocalVariables.Apply()
    • LocalVariables.SetVariable()
    • LocalVariables.UnsetVariable()
  • Read()
  • ReadBool()
  • ReadBools()
  • ReadFloat()
  • ReadFloats()
  • ReadInt()
  • ReadInts()
  • ReadProperties()
  • ReadScalar()
  • ReadString()
  • ReadStrings()
  • ReadVector()
  • ReadVectorPhiThetaMag()
  • ReadVectorXY()
  • ReadVectorXYZ()
  • RemoveFromGlobalDictionary()
  • TestFunction()
• BasicTools.Helpers.PrintBypass module
  • CheckIntegrity()
  • PrintBypass
    • PrintBypass.CopyOutputToDisk()
    • PrintBypass.Print()
    • PrintBypass.PrintCerr()
    • PrintBypass.Restore()
    • PrintBypass.ToDisk()
    • PrintBypass.ToRedirect()
    • PrintBypass.ToSink()
  • eprint()
• BasicTools.Helpers.Profiler module
  • CheckIntegrity()
  • Profiler
    • Profiler.Start()
    • Profiler.Stop()
• BasicTools.Helpers.ProgressBar module
  • CheckIntegrity()
  • printProgressBar()
• BasicTools.Helpers.Search module
  • BinarySearch()
  • CheckIntegrity()
• BasicTools.Helpers.Tests module
  • CheckIfAllThePresentFilesAreTested()
  • CheckIntegrity()
  • GetUniqueTempFile()
  • RunListOfCheckIntegrities()
  • RunTests()
  • SkipTest()
  • TestAll()
  • TestTempDir
    • TestTempDir.DeleteTempPath()
    • TestTempDir.GetTempPath()
    • TestTempDir.OpenTempFolder()
    • TestTempDir.SetTempPath()
    • TestTempDir.createdOnRam
    • TestTempDir.path
    • TestTempDir.prefix
  • WriteTempFile()
• BasicTools.Helpers.TextFormatHelper module
  • CheckIntegrity()
  • TFormat
    • TFormat.AddToExtra()
    • TFormat.Center()
    • TFormat.CleanFormat()
    • TFormat.DI()
    • TFormat.GetIndent()
    • TFormat.GoodBad()
    • TFormat.II()
    • TFormat.InBlue()
    • TFormat.InBlueBackGround()
    • TFormat.InGreen()
    • TFormat.InGreenBackGround()
    • TFormat.InGrey()
    • TFormat.InGreyBackGround()
    • TFormat.InIPython()
    • TFormat.InPurple()
    • TFormat.InPurpleBackGround()
    • TFormat.InRed()
    • TFormat.InRedBackGround()
    • TFormat.InYellow()
    • TFormat.InYellowBackGround()
    • TFormat.Left()
    • TFormat.Reset()
    • TFormat.SupportsColor()
    • TFormat.WithColor()
    • TFormat.WithItalic()
    • TFormat.WithUnderline()
  • strip_ANSI_escape_sequences_sub()
• BasicTools.Helpers.Timer module
  • CheckIntegrity()
  • Timer
    • Timer.GetDiffTime()
    • Timer.PrintTimes()
    • Timer.Reset()
    • Timer.Start()
    • Timer.Stop()
    • Timer.almanac
• BasicTools.Helpers.which module
  • CheckIntegrity()
  • which()