mythos.energy.na1
Implementation of the oxNA energy model in mythos.
Submodules
- mythos.energy.na1.bonded_excluded_volume
- mythos.energy.na1.coaxial_stacking
- mythos.energy.na1.cross_stacking
- mythos.energy.na1.debye
- mythos.energy.na1.fene
- mythos.energy.na1.hydrogen_bonding
- mythos.energy.na1.nucleotide
- mythos.energy.na1.stacking
- mythos.energy.na1.unbonded_excluded_volume
- mythos.energy.na1.utils
Classes
Bonded excluded volume energy function for NA1 model. |
|
Configuration for the bonded excluded volume energy function. |
|
Coaxial stacking energy function for NA1 model. |
|
Configuration for the cross-stacking energy function. |
|
Cross-stacking energy function for NA1 model. |
|
Configuration for the cross-stacking energy function. |
|
Debye-huckel energy function for NA1 model. |
|
Configuration for the debye-huckel energy function. |
|
FENE energy function for NA1 model. |
|
Configuration for the FENE energy function. |
|
Hydrogen bonding energy function for NA1 model. |
|
Configuration for the cross-stacking energy function. |
|
Nucleotide rigid body with additional sites for NA1. |
|
Stacking energy function for DNA1 model. |
|
Configuration for the stacking energy function. |
|
Unbonded excluded volume energy function for NA1 model. |
|
Configuration for the unbonded excluded volume energy function. |
Package Contents
- class mythos.energy.na1.BondedExcludedVolume[source]
Bases:
mythos.energy.base.BaseEnergyFunctionBonded excluded volume energy function for NA1 model.
- compute_energy(nucleotide: mythos.energy.na1.nucleotide.HybridNucleotide) mythos.utils.types.Scalar[source]
Compute the energy of the system given the nucleotide.
- class mythos.energy.na1.BondedExcludedVolumeConfiguration[source]
Bases:
mythos.energy.configuration.BaseConfigurationConfiguration for the bonded excluded volume energy function.
- dna_config: mythos.energy.dna1.BondedExcludedVolumeConfiguration | None = None
- rna_config: mythos.energy.dna1.BondedExcludedVolumeConfiguration | None = None
- required_params: tuple[str] = ('nt_type', 'dna_eps_exc', 'dna_dr_star_base', 'dna_sigma_base', 'dna_sigma_back_base',...
- init_params() BondedExcludedVolumeConfiguration[source]
Initializes the dependent parameters in configuration.
Should be implemented in the subclass if dependent parameters are present.
- class mythos.energy.na1.CoaxialStacking[source]
Bases:
mythos.energy.base.BaseEnergyFunctionCoaxial stacking energy function for NA1 model.
- params: CoaxialStackingConfiguration
- compute_energy(nucleotide: mythos.energy.na1.nucleotide.HybridNucleotide) mythos.utils.types.Scalar[source]
Compute the energy of the system given the nucleotide.
- class mythos.energy.na1.CoaxialStackingConfiguration[source]
Bases:
mythos.energy.configuration.BaseConfigurationConfiguration for the cross-stacking energy function.
- dna_config: mythos.energy.dna2.CoaxialStackingConfiguration | None = None
- rna_config: mythos.energy.dna1.CoaxialStackingConfiguration | None = None
- drh_config: mythos.energy.dna1.CoaxialStackingConfiguration | None = None
- required_params: tuple[str] = ('nt_type', 'dna_dr_low_coax', 'dna_dr_high_coax', 'dna_k_coax', 'dna_dr0_coax',...
- init_params() CoaxialStackingConfiguration[source]
Initializes the dependent parameters in configuration.
Should be implemented in the subclass if dependent parameters are present.
- class mythos.energy.na1.CrossStacking[source]
Bases:
mythos.energy.base.BaseEnergyFunctionCross-stacking energy function for NA1 model.
- params: CrossStackingConfiguration
- compute_energy(nucleotide: mythos.energy.na1.nucleotide.HybridNucleotide) mythos.utils.types.Scalar[source]
Compute the energy of the system given the nucleotide.
- class mythos.energy.na1.CrossStackingConfiguration[source]
Bases:
mythos.energy.configuration.BaseConfigurationConfiguration for the cross-stacking energy function.
- dna_config: mythos.energy.dna1.CrossStackingConfiguration | None = None
- rna_config: mythos.energy.rna2.CrossStackingConfiguration | None = None
- drh_config: mythos.energy.dna1.CrossStackingConfiguration | None = None
- required_params: tuple[str] = ('nt_type', 'dna_dr_low_cross', 'dna_dr_high_cross', 'dna_k_cross', 'dna_r0_cross',...
- init_params() CrossStackingConfiguration[source]
Initializes the dependent parameters in configuration.
Should be implemented in the subclass if dependent parameters are present.
- class mythos.energy.na1.Debye[source]
Bases:
mythos.energy.dna2.DebyeDebye-huckel energy function for NA1 model.
- params: DebyeConfiguration
- compute_energy(nucleotide: mythos.energy.na1.nucleotide.HybridNucleotide) mythos.utils.types.Scalar[source]
Compute the energy of the system given the nucleotide.
- class mythos.energy.na1.DebyeConfiguration[source]
Bases:
mythos.energy.configuration.BaseConfigurationConfiguration for the debye-huckel energy function.
- dna_config: mythos.energy.dna2.DebyeConfiguration | None = None
- rna_config: mythos.energy.dna2.DebyeConfiguration | None = None
- drh_config: mythos.energy.dna2.DebyeConfiguration | None = None
- required_params: tuple[str] = ('nt_type', 'half_charged_ends', 'kt', 'salt_conc', 'dna_q_eff', 'dna_lambda_factor',...
- init_params() DebyeConfiguration[source]
Initializes the dependent parameters in configuration.
Should be implemented in the subclass if dependent parameters are present.
- class mythos.energy.na1.Fene[source]
Bases:
mythos.energy.base.BaseEnergyFunctionFENE energy function for NA1 model.
- params: FeneConfiguration
- compute_energy(nucleotide: mythos.energy.na1.nucleotide.HybridNucleotide) mythos.utils.types.Scalar[source]
Compute the energy of the system given the nucleotide.
- class mythos.energy.na1.FeneConfiguration[source]
Bases:
mythos.energy.configuration.BaseConfigurationConfiguration for the FENE energy function.
- dna_config: mythos.energy.dna1.FeneConfiguration | None = None
- rna_config: mythos.energy.dna1.FeneConfiguration | None = None
- required_params: tuple[str] = ('nt_type', 'dna_eps_backbone', 'dna_r0_backbone', 'dna_delta_backbone', 'dna_fmax', 'dna_finf',...
- init_params() FeneConfiguration[source]
Initializes the dependent parameters in configuration.
Should be implemented in the subclass if dependent parameters are present.
- class mythos.energy.na1.HydrogenBonding[source]
Bases:
mythos.energy.base.BaseEnergyFunctionHydrogen bonding energy function for NA1 model.
- params: HydrogenBondingConfiguration
- compute_energy(nucleotide: mythos.energy.na1.nucleotide.HybridNucleotide) mythos.utils.types.Scalar[source]
Compute the energy of the system given the nucleotide.
- class mythos.energy.na1.HydrogenBondingConfiguration[source]
Bases:
mythos.energy.configuration.BaseConfigurationConfiguration for the cross-stacking energy function.
- pseq_constraints: mythos.input.sequence_constraints.SequenceConstraints | None = None
- dna_config: mythos.energy.dna1.HydrogenBondingConfiguration | None = None
- rna_config: mythos.energy.dna1.HydrogenBondingConfiguration | None = None
- drh_config: mythos.energy.dna1.HydrogenBondingConfiguration | None = None
- required_params: tuple[str] = ('nt_type', 'dna_eps_hb', 'dna_a_hb', 'dna_dr0_hb', 'dna_dr_c_hb', 'dna_dr_low_hb',...
- init_params() HydrogenBondingConfiguration[source]
Initializes the dependent parameters in configuration.
Should be implemented in the subclass if dependent parameters are present.
- class mythos.energy.na1.HybridNucleotide[source]
Nucleotide rigid body with additional sites for NA1.
This class is inteneded to be used as a dataclass for a nucleotide rigid body as a rigid_body_transform_fn in jax_md.energy.ComposedEnergyFunction.
- static from_rigid_body(rigid_body: jax_md.rigid_body.RigidBody, dna_com_to_backbone_x: mythos.utils.types.Scalar, dna_com_to_backbone_y: mythos.utils.types.Scalar, dna_com_to_backbone_dna1: mythos.utils.types.Scalar, dna_com_to_hb: mythos.utils.types.Scalar, dna_com_to_stacking: mythos.utils.types.Scalar, rna_com_to_backbone_x: mythos.utils.types.Scalar, rna_com_to_backbone_y: mythos.utils.types.Scalar, rna_com_to_stacking: mythos.utils.types.Scalar, rna_com_to_hb: mythos.utils.types.Scalar, rna_p3_x: mythos.utils.types.Scalar, rna_p3_y: mythos.utils.types.Scalar, rna_p3_z: mythos.utils.types.Scalar, rna_p5_x: mythos.utils.types.Scalar, rna_p5_y: mythos.utils.types.Scalar, rna_p5_z: mythos.utils.types.Scalar, rna_pos_stack_3_a1: mythos.utils.types.Scalar, rna_pos_stack_3_a2: mythos.utils.types.Scalar, rna_pos_stack_5_a1: mythos.utils.types.Scalar, rna_pos_stack_5_a2: mythos.utils.types.Scalar) HybridNucleotide[source]
Class method to precompute nucleotide sites from a rigid body.
- class mythos.energy.na1.Stacking[source]
Bases:
mythos.energy.base.BaseEnergyFunctionStacking energy function for DNA1 model.
- params: StackingConfiguration
- compute_energy(nucleotide: mythos.energy.na1.nucleotide.HybridNucleotide) mythos.utils.types.Scalar[source]
Compute the energy of the system given the nucleotide.
- class mythos.energy.na1.StackingConfiguration[source]
Bases:
mythos.energy.configuration.BaseConfigurationConfiguration for the stacking energy function.
- dna_config: mythos.energy.dna1.StackingConfiguration | None = None
- rna_config: mythos.energy.rna2.StackingConfiguration | None = None
- required_params: tuple[str] = ('nt_type', 'kt', 'dna_eps_stack_base', 'dna_eps_stack_kt_coeff', 'dna_dr_low_stack',...
- init_params() StackingConfiguration[source]
Initializes the dependent parameters in configuration.
Should be implemented in the subclass if dependent parameters are present.
- class mythos.energy.na1.UnbondedExcludedVolume[source]
Bases:
mythos.energy.base.BaseEnergyFunctionUnbonded excluded volume energy function for NA1 model.
- compute_energy(nucleotide: mythos.energy.na1.nucleotide.HybridNucleotide) mythos.utils.types.Scalar[source]
Compute the energy of the system given the nucleotide.
- class mythos.energy.na1.UnbondedExcludedVolumeConfiguration[source]
Bases:
mythos.energy.configuration.BaseConfigurationConfiguration for the unbonded excluded volume energy function.
- dna_config: mythos.energy.dna1.UnbondedExcludedVolumeConfiguration | None = None
- rna_config: mythos.energy.dna1.UnbondedExcludedVolumeConfiguration | None = None
- drh_config: mythos.energy.dna1.UnbondedExcludedVolumeConfiguration | None = None
- required_params: tuple[str] = ('nt_type', 'dna_eps_exc', 'dna_dr_star_base', 'dna_sigma_base', 'dna_dr_star_back_base',...
- init_params() UnbondedExcludedVolumeConfiguration[source]
Initializes the dependent parameters in configuration.
Should be implemented in the subclass if dependent parameters are present.