IMLCV package#
Subpackages#
- IMLCV.base package
- Submodules
- IMLCV.base.CV module
CVCollectiveVariableCvFunCvFunBaseCvMetricCvTransNeighbourListNeighbourList.apply_fun_neighbour()NeighbourList.apply_fun_neighbour_pair()NeighbourList.atom_indicesNeighbourList.batch()NeighbourList.batch_dimNeighbourList.batchedNeighbourList.canonicalized_sp()NeighbourList.create()NeighbourList.ijk_indicesNeighbourList.infoNeighbourList.needs_calculationNeighbourList.needs_update()NeighbourList.neighbour_pos()NeighbourList.nl_split_z()NeighbourList.nneighs()NeighbourList.op_cellNeighbourList.op_centerNeighbourList.op_coorNeighbourList.padding_boolsNeighbourList.replace()NeighbourList.shapeNeighbourList.sp_origNeighbourList.stack()NeighbourList.stack_dimsNeighbourList.unstack()NeighbourList.updateNeighbourList.update_nl()
NeighbourListInfoNeighbourListUpdateShmapKwargsSystemParamsSystemParams.angles()SystemParams.apply_canonicalize()SystemParams.apply_minkowski_reduction()SystemParams.apply_rotation()SystemParams.apply_wrap()SystemParams.batch()SystemParams.batch_dimSystemParams.batchedSystemParams.canonicalize()SystemParams.cellSystemParams.coordinatesSystemParams.get_neighbour_list()SystemParams.min_distance()SystemParams.minkowski_reduce()SystemParams.replace()SystemParams.rotate_cell()SystemParams.shapeSystemParams.stack()SystemParams.super_cell()SystemParams.to_absolute()SystemParams.to_ase()SystemParams.to_relative()SystemParams.unbatch()SystemParams.volume()SystemParams.wrap_positions()
macro_chunk_map()macro_chunk_map_fun()padded_shard_map()padded_vmap()
- IMLCV.base.CVDiscovery module
- IMLCV.base.MdEngine module
MDEngineMDEngine.biasMDEngine.create()MDEngine.energyMDEngine.get_bias()MDEngine.get_energy()MDEngine.get_trajectory()MDEngine.load()MDEngine.new_bias()MDEngine.nlMDEngine.r_skinMDEngine.run()MDEngine.save()MDEngine.save_step()MDEngine.spMDEngine.static_trajectory_infoMDEngine.stepMDEngine.time0MDEngine.trajectory_fileMDEngine.trajectory_infoMDEngine.update_nl()
StaticMdInfoStaticMdInfo.PStaticMdInfo.TStaticMdInfo.atomic_numbersStaticMdInfo.barostatStaticMdInfo.equilibrationStaticMdInfo.invalidStaticMdInfo.load()StaticMdInfo.massesStaticMdInfo.max_gradStaticMdInfo.neighbour_list_infoStaticMdInfo.r_cutStaticMdInfo.save()StaticMdInfo.screen_logStaticMdInfo.thermostatStaticMdInfo.timecon_baroStaticMdInfo.timecon_thermoStaticMdInfo.timestepStaticMdInfo.write_step
TrajectoryInfoTrajectoryInfo.CVTrajectoryInfo.CV_origTrajectoryInfo.PTrajectoryInfo.TTrajectoryInfo.cellTrajectoryInfo.chargesTrajectoryInfo.create()TrajectoryInfo.cvTrajectoryInfo.cv_origTrajectoryInfo.e_biasTrajectoryInfo.e_potTrajectoryInfo.errTrajectoryInfo.load()TrajectoryInfo.positionsTrajectoryInfo.replace()TrajectoryInfo.rhoTrajectoryInfo.save()TrajectoryInfo.shapeTrajectoryInfo.spTrajectoryInfo.tTrajectoryInfo.volumeTrajectoryInfo.w
- IMLCV.base.Observable module
- IMLCV.base.UnitsConstants module
- IMLCV.base.bias module
BiasBias.apply()Bias.bounds_from_bias()Bias.collective_variableBias.compute_from_cv()Bias.compute_from_system_params()Bias.create()Bias.finalizedBias.kl_divergence()Bias.load()Bias.log_exp_sliceBias.plot()Bias.replace()Bias.resample()Bias.save()Bias.slice()Bias.slice_exponentBias.slice_meanBias.startBias.stepBias.update_bias()
BiasErrorBiasFBiasModifyCompositeBiasEnergyEnergyErrorEnergyFnEnergyResultNoneBiasPlumedEnerg
- IMLCV.base.datastructures module
- IMLCV.base.rounds module
CovariancesCovariances.C00Covariances.C01Covariances.C10Covariances.C11Covariances.W_0Covariances.W_1Covariances.create()Covariances.decompose()Covariances.mask()Covariances.only_diagCovariances.pi_0Covariances.pi_1Covariances.pi_s_0Covariances.pi_s_1Covariances.replace()Covariances.rho_00Covariances.rho_01Covariances.rho_10Covariances.rho_11Covariances.sigma_0Covariances.sigma_0_invCovariances.sigma_1Covariances.sigma_1_invCovariances.symmetricCovariances.symmetrize()Covariances.trans_fCovariances.trans_gCovariances.whiten_rho()
DataLoaderOutputDataLoaderOutput.apply_bias()DataLoaderOutput.apply_cv()DataLoaderOutput.biasDataLoaderOutput.calc_neighbours()DataLoaderOutput.check_w()DataLoaderOutput.collective_variableDataLoaderOutput.cvDataLoaderOutput.cv_tDataLoaderOutput.filter_nans()DataLoaderOutput.get_bincount()DataLoaderOutput.get_fes_bias_from_weights()DataLoaderOutput.get_histo()DataLoaderOutput.get_point()DataLoaderOutput.get_transformed_fes()DataLoaderOutput.ground_biasDataLoaderOutput.koopman_model()DataLoaderOutput.koopman_weight()DataLoaderOutput.labelsDataLoaderOutput.nlDataLoaderOutput.nl_tDataLoaderOutput.norm_w()DataLoaderOutput.recalc()DataLoaderOutput.replace()DataLoaderOutput.scaled_tauDataLoaderOutput.spDataLoaderOutput.sp_tDataLoaderOutput.stiDataLoaderOutput.tauDataLoaderOutput.tiDataLoaderOutput.ti_tDataLoaderOutput.time_seriesDataLoaderOutput.transform_FES()DataLoaderOutput.wham_weight()
KoopmanModelKoopmanModel.T_scaleKoopmanModel.W0KoopmanModel.W1KoopmanModel.add_1KoopmanModel.argmaskKoopmanModel.calc_piKoopmanModel.constant_thresholdKoopmanModel.correlation_whitenKoopmanModel.covKoopmanModel.create()KoopmanModel.cv_0KoopmanModel.cv_tKoopmanModel.epsKoopmanModel.eps_preKoopmanModel.f()KoopmanModel.g()KoopmanModel.get_n_skip()KoopmanModel.koopman_weight()KoopmanModel.max_featuresKoopmanModel.max_features_preKoopmanModel.nlKoopmanModel.nl_tKoopmanModel.only_diagKoopmanModel.out_dimKoopmanModel.replace()KoopmanModel.rhoKoopmanModel.rho_tKoopmanModel.sKoopmanModel.scaled_tauKoopmanModel.shapeKoopmanModel.tauKoopmanModel.timescales()KoopmanModel.tot_transKoopmanModel.transKoopmanModel.verboseKoopmanModel.wKoopmanModel.w_tKoopmanModel.weighted_model()
RoundInformationRoundsRounds.PRounds.TRounds.add_cv()Rounds.add_round()Rounds.continue_run()Rounds.create()Rounds.cvRounds.data_loader()Rounds.finish_data()Rounds.folderRounds.full_path()Rounds.get_bias()Rounds.get_collective_variable()Rounds.get_engine()Rounds.get_round()Rounds.get_static_trajectory_info()Rounds.invalidate_data()Rounds.is_finished()Rounds.is_valid()Rounds.is_zipped()Rounds.iter()Rounds.iter_ase_atoms()Rounds.n()Rounds.path()Rounds.plot_cv_discovery()Rounds.plot_md_run()Rounds.plot_round()Rounds.rel_path()Rounds.roundRounds.run()Rounds.run_md()Rounds.run_par()Rounds.static_trajectory_information()Rounds.transform_CV()Rounds.unzip_cv()Rounds.unzip_cv_round()Rounds.update_CV()Rounds.validate_data()Rounds.write_xyz()Rounds.zip_cv()Rounds.zip_cv_round()Rounds.zip_cv_rounds()
TrajectoryInformationWeightOutput
- Module contents
- IMLCV.configs package
- IMLCV.examples package
- IMLCV.external package
- IMLCV.implementations package
- Subpackages
- Submodules
- IMLCV.implementations.CV module
NoneCV()affine_2d()append_trans()dihedral()distance_descriptor()get_feature_cov()get_inv_sigma_weighing()get_non_constant_trans()get_normalize_trans()get_remove_mean_trans()get_sinkhorn_divergence_2()kernel_dist()position_index()project_distances()rotate_2d()sb_descriptor()scale_cv_trans()sinkhorn_divergence_2()soap_descriptor()stack_reduce()trunc_svd()
- IMLCV.implementations.CvDiscovery module
- IMLCV.implementations.MdEngine module
- IMLCV.implementations.bias module
- IMLCV.implementations.energy module
- Module contents
- IMLCV.new_yaff namespace
- IMLCV.tools package
Submodules#
IMLCV.scheme module#
- class IMLCV.scheme.Scheme(rounds)#
Bases:
objectbase class that implements iterative scheme.
- Parameters:
format (String) – intermediate file type between rounds
CVs – list of CV instances.
- FESBias(rnd=None, cv_round=None, chunk_size=None, **plotkwargs)#
replace the current md bias with the computed FES from current round.
- Return type:
- property bias#
- grid_umbrella(steps=10000.0, k=None, n=8, max_grad=None, plot=True, scale_n=None, cv_round=None, ignore_invalid=False, eps=0.1, min_traj_length=None, recalc_cv=False, only_finished=True, chunk_size=None, use_common_bias=True)#
- inner_loop(rnds=10, convergence_kl=0.1, steps=50000.0, K=None, update_metric=False, n=4, samples_per_bin=5, min_samples_per_bin=1, init_max_grad=None, plot=True, choice='rbf', fes_bias_rnds=4, scale_n=None, cv_round=None, chunk_size=None, eps_umbrella=0.1, plot_margin=0.1, enforce_min_traj_length=False, recalc_cv=False, only_finished=True, plot_umbrella=False, max_bias=0.03808799176039228, n_max_fes=100000.0, thermolib=False, macro_chunk=10000, koopman=True, lag_n=30, koopman_wham=None, out=-1, direct_bias=False, init=False, first_round_without_bias=False, executors=Executors.training, use_common_bias=True, first_round_without_ground_bias=False, first_round_no_fes_bias=False)#
- property md#
- property sti#
- transform_CV(cv_trans, dlo_kwargs=None, dlo=None, chunk_size=None, new_r_cut=None, plot=True)#
- update_CV(transformer, dlo_kwargs={}, dlo=None, chunk_size=None, plot=True, new_r_cut=None, save_samples=True, save_multiple_cvs=False, jac=<function jacrev>, cv_round_from=None, test=False, max_bias=None, transform_bias=True, samples_per_bin=5, min_samples_per_bin=1, percentile=0.1, use_executor=True, n_max=100000.0, vmax=0.03808799176039228, macro_chunk=2000, macro_chunk_nl=5000, verbose=False)#
Module contents#
summary IMLCV is still underdevelopement.
- class IMLCV.JaxHandler(context)#
Bases:
BaseHandlerflattens the jax array to numpy array, which is already handled by jsonpickle
- flatten(obj, data)#
Flatten obj into a json-friendly form and write result to data.
- restore(data)#
Restore an object of the registered type from the json-friendly representation obj and return it.
- class IMLCV.Unpickler(backend=None, keys=False, safe=True, v1_decode=False, on_missing='ignore', handle_readonly=False)#
Bases:
Unpickler
- IMLCV.pytreenode_equal(self, other)#