Kernel utilities - Revision history

Kuprov: Index entries for the functions added in Spinach 2.13

2026-09-22T15:32:01Z

Index entries for the functions added in Spinach 2.13

Kuprov: sync with Spinach main 3975f139: kletter.m, wigner_fock.m, fluxonium.m, pink_noise.m

2026-09-18T10:00:53Z

sync with Spinach main 3975f139: kletter.m, wigner_fock.m, fluxonium.m, pink_noise.m

Kuprov: removed index entry for deleted function summary.m (removed per IK instruction 2026-08-30)

2026-08-30T09:12:02Z

removed index entry for deleted function summary.m (removed per IK instruction 2026-08-30)

Kuprov: sync with Spinach main f053e432: anax2quat.m -> anax2qter.m, quat2anax.m -> qter2anax.m

2026-08-30T08:29:22Z

sync with Spinach main f053e432: anax2quat.m -> anax2qter.m, quat2anax.m -> qter2anax.m

Kuprov: sync with Spinach main f053e432: add summary_symmetry.m, summary_zeeman.m, validate_sym.m to housekeeping list

2026-08-30T08:27:38Z

sync with Spinach main f053e432: add summary_symmetry.m, summary_zeeman.m, validate_sym.m to housekeeping list

Kuprov: sync with Spinach main f053e432: index save_vstore.m, sgolaydiff.m, sim2liouv.m, sp_block_diag.m, spsortrows.m, spunicols.m, summary_basis.m, summary_basis_opts.m, summary_chemistry.m

2026-08-30T08:23:14Z

sync with Spinach main f053e432: index save_vstore.m, sgolaydiff.m, sim2liouv.m, sp_block_diag.m, spsortrows.m, spunicols.m, summary_basis.m, summary_basis_opts.m, summary_chemistry.m

Kuprov: sync with Spinach main f053e432: add ten kernel/summaries functions to housekeeping list

2026-08-30T08:22:47Z

sync with Spinach main f053e432: add ten kernel/summaries functions to housekeeping list

Kuprov: sync with Spinach main f053e432: index nutation_dist.m, pseudomodulation.m, qter2dcm.m, qter2euler.m, rootmatch.m

2026-08-30T08:14:12Z

sync with Spinach main f053e432: index nutation_dist.m, pseudomodulation.m, qter2dcm.m, qter2euler.m, rootmatch.m

Kuprov: sync with Spinach main f053e432: add load_vstore.m to the parallelisation and GPU list

2026-08-30T08:13:45Z

sync with Spinach main f053e432: add load_vstore.m to the parallelisation and GPU list

Kuprov: new pages for Spinach main f053e432: add euler2qter.m, euler_equiv.m, fig2tiles.m, gausscon.m to the function lists

2026-08-30T08:04:32Z

new pages for Spinach main f053e432: add euler2qter.m, euler_equiv.m, fig2tiles.m, gausscon.m to the function lists

← Older revision		Revision as of 15:32, 22 September 2026
Line 341:		Line 341:

	[[rlx_modes.m]] - thermalised GKSL dissipators for damped and dephasing bosonic modes.		[[rlx_modes.m]] - thermalised GKSL dissipators for damped and dephasing bosonic modes.
		+
		+	[[rlx_phonon.m]] - spin-phonon relaxation in the generalised Lindblad form of Saito and Miyashita.

	[[rlx_scalar.m]] - scalar relaxation superoperator.		[[rlx_scalar.m]] - scalar relaxation superoperator.

@@ Line 199: / Line 199: @@
 [[fdweights.m]] – finite difference stencil weights.
 [[fpl2phan.m]] – partial trace with respect to spin degrees of freedom applied to a Fokker-Planck state vector.
@@ Line 291: / Line 293: @@
 [[heterodyne.m]] - carrier frequency demodulation.
 [[molplot.m]] – stick plots of molecules.
@@ Line 315: / Line 319: @@
 [[volplot.m]] – volumetric plotting.
 [[xyz2pd.m]] - probability density estimation for a 3D Cartesian point cloud.
@@ Line 410: / Line 416: @@
 [[mprealloc.m]] - Preallocates an operator in the current formalism and basis.
 [[remncomm.m]] - The part of the matrix that commutes with another matrix.

← Older revision		Revision as of 09:12, 30 August 2026
Line 509:		Line 509:

	[[sniff.m]] - kernel integrity control, kernel code modification sniffer.		[[sniff.m]] - kernel integrity control, kernel code modification sniffer.
−
−	~~[[summary.m]] - prints various summaries for Spinach kernel. Should not be called directly.~~

	[[summary_basis.m]] - prints the basis-set state summary. Should not be called directly.		[[summary_basis.m]] - prints the basis-set state summary. Should not be called directly.

@@ Line 37: / Line 37: @@
 [[anax2dcm.m]] - Converts angle-axis rotation parameters to directional cosine matrix.
-[[anax2quat.m]] - Converts angle-axis rotation parameters into a quaternion.
+[[anax2qter.m]] - Converts angle-axis rotation parameters into a quaternion.
 [[axis_tsymm.m]] - Roughly averages an interaction tensor with respect to the rotation around a user-specified axis.
@@ Line 63: / Line 63: @@
 [[wigner.m]] - Converts Euler angles into Wigner rotation matrix.
-[[quat2anax.m]] - Converts a quaternion into an angle-axis specification.
+[[qter2anax.m]] - Converts a quaternion into an angle-axis specification.
 [[rotmat_align.m]] - Rotation matrix aligning one vector with another vector.

@@ Line 537: / Line 537: @@
 [[summary_rlx_weiz.m]] - prints the Weizmann DNP relaxation rate summary. Should not be called directly.
 [[symmetry.m]] - Symmetry treatment. This is a service function of the Spinach kernel that should not be called directly.
 [[tolerances.m]] - tolerance information for Spinach kernel. Should not be called directly.
 [[wiki.m]] - opens Spinach documentation Wiki.

@@ Line 251: / Line 251: @@
 [[scomponents.m]] – strongly connected components of a graph
 [[sinkhole.m]] – designates specific states as sinkholes
@@ Line 257: / Line 259: @@
 [[sphten2zeeman.m]] - basis set conversion from irreducible spherical tensors into Zeeman basis.
 [[path_trace.m]] – disconnected subspace discovery by Liouvillian path tracing
@@ Line 414: / Line 420: @@
 [[rspt_eig.m]] - Eigensystems of spin Hamiltonians and their derivatives.
 [[snormpdf.m]] - Azzalini's skew normal distribution.
 [[svd_shrink.m]] - Vector-covector pairs for the parallel propagation in Hilbert space.
@@ Line 501: / Line 511: @@
 [[summary.m]] - prints various summaries for Spinach kernel. Should not be called directly.
 [[summary_coordinates.m]] - prints the atomic coordinate summary. Should not be called directly.
@@ Line 547: / Line 563: @@
 [[save_anyway.m]] - ignores parallel pool restrictions for save operations.
 [[smack.m]] - forcibly shuts down the parallel pool and clears the workspace.

← Older revision		Revision as of 08:22, 30 August 2026
Line 501:		Line 501:

	[[summary.m]] - prints various summaries for Spinach kernel. Should not be called directly.		[[summary.m]] - prints various summaries for Spinach kernel. Should not be called directly.
		+
		+	[[summary_coordinates.m]] - prints the atomic coordinate summary. Should not be called directly.
		+
		+	[[summary_couplings.m]] - prints the spin-spin coupling tensor summary. Should not be called directly.
		+
		+	[[summary_mode_coup.m]] - prints the bosonic mode coupling summary. Should not be called directly.
		+
		+	[[summary_mode_mods.m]] - prints the summary of spin Hamiltonian modulation by bosonic mode coordinates. Should not be called directly.
		+
		+	[[summary_modes.m]] - prints the bosonic mode parameter summary. Should not be called directly.
		+
		+	[[summary_pbc.m]] - prints the periodic boundary condition vector summary. Should not be called directly.
		+
		+	[[summary_rlx_lindblad.m]] - prints the Lindblad relaxation rate summary. Should not be called directly.
		+
		+	[[summary_rlx_nott.m]] - prints the Nottingham DNP relaxation rate summary. Should not be called directly.
		+
		+	[[summary_rlx_t1_t2.m]] - prints the T1 and T2 relaxation rate summary. Should not be called directly.
		+
		+	[[summary_rlx_weiz.m]] - prints the Weizmann DNP relaxation rate summary. Should not be called directly.

	[[symmetry.m]] - Symmetry treatment. This is a service function of the Spinach kernel that should not be called directly.		[[symmetry.m]] - Symmetry treatment. This is a service function of the Spinach kernel that should not be called directly.

@@ Line 54: / Line 54: @@
 [[euler_sup.m]] - Superposes two active ZYZ Euler rotations.
 [[rotor_stack.m]] - Produces rotor stack of Liouvillians or Hamiltonians.
@@ Line 283: / Line 287: @@
 [[molplot.m]] – stick plots of molecules.
 [[plot_1d.m]] – 1D spectral plotting utility.
@@ Line 291: / Line 297: @@
 [[plot_uf.m]] - ultrafast NMR plotting utility.
 [[slice_2d.m]] – displays slices of 2D spectra.
@@ Line 400: / Line 408: @@
 [[remtrace.m]] - Zeroes out the trace of a 3x3 interaction tensor.
 [[rspert.m]] - Rayleigh-Schrodinger perturbation theory to arbitrary order.

← Older revision		Revision as of 08:13, 30 August 2026
Line 507:		Line 507:

	[[isworkernode.m]] - returns true if running on a parallel worker node.		[[isworkernode.m]] - returns true if running on a parallel worker node.
		+
		+	[[load_vstore.m]] - loads the parallel pool ValueStore from a MAT file.

	[[parallel_profiler_start.m]] - start parallel profiling.		[[parallel_profiler_start.m]] - start parallel profiling.

@@ Line 48: / Line 48: @@
 [[euler2dcm.m]] - Converts Euler angles into directional cosine matrix.
 [[euler_sup.m]] - Superposes two active ZYZ Euler rotations.
@@ Line 269: / Line 273: @@
 [[crop_2d.m]] - Crops 2D spectra to user-specified ranges.
 [[int_2d.m]] – 2D spectral integration utility.
@@ Line 364: / Line 370: @@
 [[frob_chop.m]] - Truncates SVD decomposition to the user-specified threshold in the Frobenius norm.
 [[gaussfun.m]] - Normalised Gaussian function in magnetic resonance notation.