Auto-FOX Documentation

• Radial & Angular Distribution Function
  • API
• Root Mean Squared Displacement & Fluctuation
  • Root Mean Squared Displacement
  • Root Mean Squared Fluctuation
  • The atom_subset argument
  • API
• The MultiMolecule Class
  • API FOX.MultiMolecule
    • MultiMolecule
      • MultiMolecule.atoms
      • MultiMolecule.bonds
      • MultiMolecule.properties
      • MultiMolecule.lattice
      • MultiMolecule.round()
      • MultiMolecule.delete_atoms()
      • MultiMolecule.get_supercell()
      • MultiMolecule.concatenate()
      • MultiMolecule.add_atoms()
      • MultiMolecule.guess_bonds()
      • MultiMolecule.random_slice()
      • MultiMolecule.reset_origin()
      • MultiMolecule.sort()
      • MultiMolecule.residue_argsort()
      • MultiMolecule.get_center_of_mass()
      • MultiMolecule.get_bonds_per_atom()
      • MultiMolecule.init_average_velocity()
      • MultiMolecule.init_time_averaged_velocity()
      • MultiMolecule.init_rmsd()
      • MultiMolecule.init_rmsf()
      • MultiMolecule.get_average_velocity()
      • MultiMolecule.get_time_averaged_velocity()
      • MultiMolecule.get_velocity()
      • MultiMolecule.get_rmsd()
      • MultiMolecule.get_rmsf()
      • MultiMolecule.init_shell_search()
      • MultiMolecule.get_at_idx()
      • MultiMolecule.init_rdf()
      • MultiMolecule.init_debye_scattering()
      • MultiMolecule.get_dist_mat()
      • MultiMolecule.get_pair_dict()
      • MultiMolecule.init_power_spectrum()
      • MultiMolecule.get_vacf()
      • MultiMolecule.T
      • MultiMolecule.all()
      • MultiMolecule.any()
      • MultiMolecule.argmax()
      • MultiMolecule.argmin()
      • MultiMolecule.argpartition()
      • MultiMolecule.argsort()
      • MultiMolecule.astype()
      • MultiMolecule.atnum
      • MultiMolecule.atom1
      • MultiMolecule.atom12
      • MultiMolecule.atom2
      • MultiMolecule.base
      • MultiMolecule.byteswap()
      • MultiMolecule.choose()
      • MultiMolecule.clip()
      • MultiMolecule.compress()
      • MultiMolecule.conj()
      • MultiMolecule.conjugate()
      • MultiMolecule.connectors
      • MultiMolecule.copy()
      • MultiMolecule.ctypes
      • MultiMolecule.cumprod()
      • MultiMolecule.cumsum()
      • MultiMolecule.data
      • MultiMolecule.diagonal()
      • MultiMolecule.dtype
      • MultiMolecule.dump()
      • MultiMolecule.dumps()
      • MultiMolecule.fill()
      • MultiMolecule.flags
      • MultiMolecule.C_CONTIGUOUS
      • MultiMolecule.F_CONTIGUOUS
      • MultiMolecule.OWNDATA
      • MultiMolecule.WRITEABLE
      • MultiMolecule.ALIGNED
      • MultiMolecule.WRITEBACKIFCOPY
      • MultiMolecule.FNC
      • MultiMolecule.FORC
      • MultiMolecule.BEHAVED
      • MultiMolecule.CARRAY
      • MultiMolecule.FARRAY
      • MultiMolecule.flat
      • MultiMolecule.flatten()
      • MultiMolecule.getfield()
      • MultiMolecule.imag
      • MultiMolecule.init_adf()
      • MultiMolecule.item()
      • MultiMolecule.itemset()
      • MultiMolecule.itemsize
      • MultiMolecule.loc
      • MultiMolecule.mol
      • MultiMolecule.atoms_view
      • MultiMolecule.mass
      • MultiMolecule.max()
      • MultiMolecule.mean()
      • MultiMolecule.min()
      • MultiMolecule.nbytes
      • MultiMolecule.ndim
      • MultiMolecule.newbyteorder()
      • MultiMolecule.nonzero()
      • MultiMolecule.order
      • MultiMolecule.partition()
      • MultiMolecule.prod()
      • MultiMolecule.ptp()
      • MultiMolecule.put()
      • MultiMolecule.radius
      • MultiMolecule.ravel()
      • MultiMolecule.real
      • MultiMolecule.repeat()
      • MultiMolecule.reshape()
      • MultiMolecule.resize()
      • MultiMolecule.searchsorted()
      • MultiMolecule.setfield()
      • MultiMolecule.setflags()
      • MultiMolecule.shape
      • MultiMolecule.size
      • MultiMolecule.squeeze()
      • MultiMolecule.std()
      • MultiMolecule.strides
      • MultiMolecule.sum()
      • MultiMolecule.swapaxes()
      • MultiMolecule.symbol
      • MultiMolecule.take()
      • MultiMolecule.tobytes()
      • MultiMolecule.tofile()
      • MultiMolecule.tolist()
      • MultiMolecule.tostring()
      • MultiMolecule.trace()
      • MultiMolecule.transpose()
      • MultiMolecule.var()
      • MultiMolecule.view()
      • MultiMolecule.x
      • MultiMolecule.y
      • MultiMolecule.z
      • MultiMolecule.as_pdb()
      • MultiMolecule.as_mol2()
      • MultiMolecule.as_mol()
      • MultiMolecule.as_xyz()
      • MultiMolecule.as_mass_weighted()
      • MultiMolecule.from_mass_weighted()
      • MultiMolecule.as_Molecule()
      • MultiMolecule.from_Molecule()
      • MultiMolecule.as_ase()
      • MultiMolecule.from_ase()
      • MultiMolecule.from_xyz()
      • MultiMolecule.from_kf()
• Addaptive Rate Monte Carlo
  • The algorithm
  • Parameters
  • The pes block
  • The param block
  • Parameter Guessing
  • State-averaged ARMC
• Monte Carlo Parameters
  • Index
  • param
    • param.type
    • param.move_range
    • param.func
    • param.kwargs
    • param.validation.allow_non_existent
    • param.validation.charge_tolerance
    • param.validation.enforce_constraints
    • param.block.param
    • param.block.unit
    • param.block.constraints
    • param.block.guess
    • param.block.frozen
  • psf
    • psf.str_file
    • psf.rtf_file
    • psf.psf_file
    • psf.ligand_atoms
  • pes
    • pes.block.func
    • pes.block.ref
    • pes.block.kwargs
    • pes.block.err_func
  • pes_validation
    • pes_validation.block.func
    • pes_validation.block.ref
    • pes_validation.block.kwargs
  • job
    • job.type
    • job.molecule
    • job.lattice
    • job.block.type
    • job.block.settings
    • job.block.template
  • monte_carlo
    • monte_carlo.type
    • monte_carlo.iter_len
    • monte_carlo.sub_iter_len
    • monte_carlo.logfile
    • monte_carlo.hdf5_file
    • monte_carlo.path
    • monte_carlo.folder
    • monte_carlo.keep_files
  • phi
    • phi.type
    • phi.gamma
    • phi.a_target
    • phi.phi
    • phi.func
    • phi.kwargs
• Multi-XYZ reader
  • API
    • read_multi_xyz()
    • example_xyz
• FOX.ff.lj_param
  • Index
  • API
    • estimate_lj()
    • get_free_energy()
• PSFContainer
  • Index
  • API
• PRMContainer
  • Index
  • API
    • PRMContainer.read()
    • PRMContainer.write()
    • PRMContainer.overlay_mapping()
    • PRMContainer.overlay_cp2k_settings()
• Properties
• Recipes
  • FOX.recipes.param
    • Index
    • API
      • get_best()
      • overlay_descriptor()
      • plot_descriptor()
  • FOX.recipes.psf
    • Index
    • API
      • generate_psf()
      • generate_psf2()
      • extract_ligand()
  • FOX.recipes.ligands
    • Index
    • API
      • get_lig_center()
      • get_multi_lig_center()
  • FOX.recipes.time_resolution
    • Index
    • API
      • time_resolved_rdf()
      • time_resolved_adf()
  • FOX.recipes.similarity
    • Index
    • API
      • compare_trajectories()
      • fps_reduce()