opal package

Subpackages

• opal.analysis package
  • Notebooks
    • cyclotron
      • Load the RingCyclotron.stat file
      • Set the plotting style
      • Turn Separation
      • RF Phases
  • opal.analysis.FieldAnalysis module
  • opal.analysis.H5Statistics module
  • opal.analysis.OptimizerAnalysis module
  • opal.analysis.SamplerStatistics module
  • opal.analysis.Statistics module
  • opal.analysis.StdOpalOutputAnalysis module
  • opal.analysis.TrackOrbitAnalysis module
  • opal.analysis.cyclotron module
  • opal.analysis.pareto_fronts module
• opal.datasets package
  • Notebooks
    • StatDataSet_Wrapper
  • opal.datasets.AmrDataset module
  • opal.datasets.DatasetBase module
  • opal.datasets.FieldDataset module
  • opal.datasets.GridDataset module
  • opal.datasets.H5Dataset module
  • opal.datasets.LBalDataset module
  • opal.datasets.LossDataset module
  • opal.datasets.MemoryDataset module
  • opal.datasets.OptimizerDataset module
  • opal.datasets.PeakDataset module
  • opal.datasets.ProbeHistDataset module
  • opal.datasets.SDDSDatasetBase module
  • opal.datasets.SamplerDataset module
  • opal.datasets.SolverDataset module
  • opal.datasets.StatDataset module
  • opal.datasets.StdOpalOutputDataset module
  • opal.datasets.TimeDataset module
  • opal.datasets.TrackOrbitDataset module
  • opal.datasets.filetype module
• opal.parser package
  • Notebooks
    • OptimizerParser
      • Load names of design variables and objectives
      • Find number of generations run by optimizer
      • Load all data in first generation
      • Assign labels, data, and plot paralllel coord
      • Plot parallel coord plot and open in new tab:
  • opal.parser.FieldParser module
  • opal.parser.H5Error module
  • opal.parser.H5Parser module
  • opal.parser.HistogramParser module
  • opal.parser.LatticeParser module
  • opal.parser.LossParser module
  • opal.parser.OptimizerParser module
  • opal.parser.PeakParser module
  • opal.parser.SDDSParser module
  • opal.parser.TimingParser module
  • opal.parser.TrackOrbitParser module
  • opal.parser.sampler module
• opal.utilities package
  • Notebooks
    • Logger
  • opal.utilities.logger module
  • opal.utilities.wrapper module
• opal.visualization package
  • Subpackages
    • opal.visualization.statistics package
      • opal.visualization.statistics.impl_plots module
    • opal.visualization.styles package
      • Notebooks
        • Styles
          • Load the RingCyclotron.stat file
          • Load styles
          • Jupyter style
          • Default style
          • Poster Style
          • Switch back to Jupyter style
      • opal.visualization.styles.default module
      • opal.visualization.styles.jupyter module
      • opal.visualization.styles.load_style module
      • opal.visualization.styles.poster module
  • Notebooks
    • Load Dataset
    • Projection Plot
    • Slice Plot
    • Line Plot
    • Particle Plot
    • Overlay Particles onto Fields
    • H5Plotter_RingMultiBunch
    • ProbePlotter
      • Set the plotting style
      • Do some plotting …
    • ProbePlotter_PeakFile
      • Load the files
      • Set the plotting style
      • Do some plotting …
    • OptimizerPlotter
      • Load the files
      • Set the plotting style
      • Do some plotting …
    • SamplerPlotter
      • Load the files
      • Set the plotting style
      • Do some plotting …
    • StatPlotter_FODO
      • Load the Gantry.stat file
      • Set the plotting style
      • Envelope Plot
    • StatPlotter_Gantry
      • Load the RingCyclotron.stat file
      • Set the plotting style
      • Envelope Plot
    • StatPlotter_RingCyclotron
      • Load the RingCyclotron.stat file
      • Set the plotting style
      • Do some plotting …
      • Load the RingCyclotron.h5 file
      • Do some plotting …
      • Do some statistics on data
      • Load the RingCyclotron.mem file
      • Do some plotting …
      • Load the RingCyclotron.lbal file
      • Do some plotting …
      • Load the RingCyclotron-trackOrbit file
      • Do some plotting …
      • Load timing.dat file
      • Do some plotting …
  • opal.visualization.AmrPlotter module
  • opal.visualization.BasePlotter module
  • opal.visualization.FieldPlotter module
  • opal.visualization.GridPlotter module
  • opal.visualization.H5Plotter module
  • opal.visualization.MemoryPlotter module
  • opal.visualization.OptimizerPlotter module
  • opal.visualization.PeakPlotter module
  • opal.visualization.ProbePlotter module
  • opal.visualization.ProfilingPlotter module
  • opal.visualization.SamplerPlotter module
  • opal.visualization.SolverPlotter module
  • opal.visualization.StatPlotter module
  • opal.visualization.StdOpalOutputPlotter module
  • opal.visualization.TimingPlotter module
  • opal.visualization.TrackOrbitPlotter module
  • opal.visualization.formatter module

opal.config module

opal.opal module

opal.opal._append_dataset(datasets, ftype, astype, directory, fname)

Append a dataset to the list.

Parameters

• datasets (list) – Collection of datasets

• ftype (FileType) – Type of file to read in

• astype (FileType) – Read a file according some dataset type E.g. OPAL standard output contains timings as well.

• directory (str) – Root directory of the OPAL simulation

• fname (str) – File to read in

Returns

True if reading is stopped (i.e. sampler, optimizer and AMR datasets), False otherwise.

Return type

bool

opal.opal.load_dataset(directory, **kwargs)

Load any file(s) produced by an OPAL simulation.

If neither ftype nor fname is specified it tries to read in a *.stat file.

Parameters

• directory (str) – Root directory of the OPAL simulation

• ftype (FileType, optional) – Type of file to read in

• fname (str or tuple, optional) – File(s) to read in

• astype (FileType, optional) – Read a file according some dataset type E.g. OPAL standard output contains timings as well.