QMOC
Documentation for QMOC.
Base.hash
QMOC.adoptedTrajectories
QMOC.allTrajectories
QMOC.archive
QMOC.archive
QMOC.archivedTrajectories
QMOC.backup
QMOC.boolArchived
QMOC.boolArchived
QMOC.boolComplete
QMOC.boolComplete
QMOC.cleanup
QMOC.countTrajectories
QMOC.loadMetadata
QMOC.loadMetadata
QMOC.missingTrajectories
QMOC.orphanedTrajectories
QMOC.parameter_circle
QMOC.parameter_distance
QMOC.parameter_full
QMOC.parameter_line
QMOC.parameter_wedge
QMOC.parametric_to_cartesian
QMOC.readTrajectory
QMOC.removeTrajectories
QMOC.standard_lines
QMOC.writeAverage
QMOC.writeMetadata
Base.hash
— Methodhash(trajectory::Trajectory) -> UInt
Returns a hash of the trajectory properties.
QMOC.adoptedTrajectories
— MethodadoptedTrajectories()
Returns a vector of all trajectory hashes in the filesystem that are in the metadata.
QMOC.allTrajectories
— MethodallTrajectories()
Returns a vector of all trajectory hashes in the filesystem.
QMOC.archive
— Methodarchive(sim::Simulation) :: Nothing
Archives all trajectories in a simulation.
QMOC.archive
— Methodarchive(traj::Trajectory) :: Nothing
Archives a trajectory by first checking if it is complete and then archiving it.
QMOC.archivedTrajectories
— MethodarchivedTrajectories()
Returns a vector of all trajectory hashes in the archive.
QMOC.backup
— Methodbackup()
Backs up all metadata and measurements (including the archive) to a folder called "backup" in the data folder.
QMOC.boolArchived
— MethodboolArchived(sim::Simulation) :: Bool
Checks if a simulation is archived, i.e. if all trajectories are archived.
QMOC.boolArchived
— MethodboolArchived(traj::Trajectory) :: Bool
Checks if a trajectory is archived, i.e. if the measurement average is present in the archive.
QMOC.boolComplete
— MethodboolComplete(sim::Simulation) :: Bool
Checks if a simulation is complete, i.e. if all linked trajectories are complete.
QMOC.boolComplete
— MethodboolComplete(traj::Trajectory) :: Bool
Checks if a trajectory is complete, i.e. if all measurements are present. Automatically averages if all measurements are present but no average is found.
QMOC.cleanup
— Methodcleanup()
Cleans up the filesystem by archiving all trajectories in the metadata and deleting all orphaned trajectories.
QMOC.countTrajectories
— MethodcountTrajectories(sim::Simulation) :: Int
Counts the number of trajectories in a simulation.
QMOC.loadMetadata
— MethodloadMetadata(name::String)
Loads the metadata of a simulation from the filesystem and returns it. If the simulation name cannot be matched, it loads all metadata.
QMOC.loadMetadata
— MethodloadMetadata()
Loads all metadata from the filesystem and returns a vector of simulations.
QMOC.missingTrajectories
— MethodmissingTrajectories(simulation::Simulation)
Returns a vector of all trajectories in a simulation that are not complete.
QMOC.orphanedTrajectories
— MethodorphanedMeasurements()
Returns a vector of all trajectory hashes in the filesystem that are not in the metadata.
QMOC.parameter_circle
— Methodparameter_circle(radius)
Returns the cartesian coordinates of a circle with radius `radius` around the isometric point.
QMOC.parameter_distance
— Methodparameter_distance(param)
Returns the distance of a parameter set (px, py, pz) from the isotropic point in the parameter space.
QMOC.parameter_full
— Methodparameter_full(resolution)
Returns a list of rational parameter sets (px, py, pz) filling the whole parameter space.
QMOC.parameter_line
— Methodparameter_line(pointA, pointB, steps)
Returns a list of rational parameter sets (px, py, pz) on a line between pointA and pointB with steps number of points.
QMOC.parameter_wedge
— Functionparameter_wedge(resolution, mode=:radial)
Returns a list of rational parameter sets (px, py, pz) filling the wedge between the isotropic point and the px=1 point, px=py point. Mode can be either :radial or :linear.
QMOC.parametric_to_cartesian
— Methodparametric_to_cartesian(params)
Returns the cartesian coordinates of a parameter set (px, py, pz).
QMOC.readTrajectory
— MethodreadTrajectory(traj::Trajectory) :: Measurement
Reads a trajectory from the archive or from the filesystem. Assumes that the trajectory is complete.
QMOC.removeTrajectories
— MethodremoveTrajectories(sim::Simulation) :: Nothing
Removes all trajectories in a simulation from the filesystem.
QMOC.standard_lines
— Methodstandard_lines(resolution)
Returns a list of rational parameter sets (px, py, pz) on the two lines between the isotropic point and the px=1 point, px=py point.
QMOC.writeAverage
— MethodwriteAverage(traj::Trajectory) :: nothing
Overwrites a trajectory file containing a measurement series with its average.
QMOC.writeMetadata
— MethodwriteMetadata(sim::Simulation) :: Nothing
Writes the metadata of a simulation to the filesystem.