OpenFF Evaluator documentation logo
  • OpenFF Evaluator documentation
  • API
  • generate_reweighting_protocols
generate_reweighting_protocols
openff-evaluator Open Force Field Initiative logo

OpenFF Evaluator documentation

Getting Started

  • Overview
  • Installation
  • Architecture
  • Evaluator Client
  • Evaluator Server

Beginner Tutorials

  • 01 - Loading Data Sets
  • 02 - Estimating Data Sets
  • 03 - Analysing Data Sets

Intermediate Tutorials

  • 04 - Optimizing Force Fields

Data Sets

  • Overview
  • ThermoML Archive
  • Taproom
  • Data Set Curation

Physical Properties

  • Overview
  • Common Workflows
  • Gradients

Calculation Layers

  • Overview
  • Workflow Layers
  • Direct Simulation
  • MBAR Reweighting

Workflows

  • Overview
  • Replicators
  • Workflow Graphs
  • Protocols
  • Protocol Groups

Observables

  • Overview

Calculation Backends

  • Overview
  • Dask Backends

Storage Backends

  • Overview
  • Data Classes and Queries
  • Local File Backend

Developer Documentation

  • Building the Docs
  • API
    • EvaluatorClient
    • BatchMode
    • ConnectionOptions
    • Request
    • RequestOptions
    • RequestResult
    • EvaluatorException
    • EvaluatorServer
    • Batch
    • PhysicalProperty
    • PropertyPhase
    • Source
    • CalculationSource
    • MeasurementSource
    • Density
    • ExcessMolarVolume
    • DielectricConstant
    • EnthalpyOfMixing
    • EnthalpyOfVaporization
    • SolvationFreeEnergy
    • HostGuestBindingAffinity
    • Substance
    • Component
    • Amount
    • ExactAmount
    • MoleFraction
    • ThermodynamicState
    • PhysicalPropertyDataSet
    • ThermoMLDataSet
    • register_thermoml_property
    • thermoml_property
    • TaproomDataSet
    • TaproomSource
    • CurationComponent
    • CurationComponentSchema
    • CurationWorkflow
    • CurationWorkflowSchema
    • FilterDuplicatesSchema
    • FilterDuplicates
    • FilterByTemperatureSchema
    • FilterByTemperature
    • FilterByPressureSchema
    • FilterByPressure
    • FilterByMoleFractionSchema
    • FilterByMoleFraction
    • FilterByRacemicSchema
    • FilterByRacemic
    • FilterByElementsSchema
    • FilterByElements
    • FilterByPropertyTypesSchema
    • FilterByPropertyTypes
    • FilterByStereochemistrySchema
    • FilterByStereochemistry
    • FilterByChargedSchema
    • FilterByCharged
    • FilterByIonicLiquidSchema
    • FilterByIonicLiquid
    • FilterBySmilesSchema
    • FilterBySmiles
    • FilterBySmirksSchema
    • FilterBySmirks
    • FilterByNComponentsSchema
    • FilterByNComponents
    • FilterBySubstancesSchema
    • FilterBySubstances
    • FilterByEnvironmentsSchema
    • FilterByEnvironments
    • ImportFreeSolvSchema
    • ImportFreeSolv
    • ImportThermoMLDataSchema
    • ImportThermoMLData
    • SelectSubstancesSchema
    • SelectSubstances
    • SelectDataPointsSchema
    • SelectDataPoints
    • State
    • TargetState
    • FingerPrintType
    • ConvertExcessDensityDataSchema
    • ConvertExcessDensityData
    • ForceFieldSource
    • SmirnoffForceFieldSource
    • TLeapForceFieldSource
    • LigParGenForceFieldSource
    • ParameterGradientKey
    • ParameterGradient
    • CalculationLayer
    • CalculationLayerResult
    • CalculationLayerSchema
    • calculation_layer
    • register_calculation_layer
    • register_calculation_schema
    • WorkflowCalculationLayer
    • WorkflowCalculationSchema
    • SimulationLayer
    • SimulationSchema
    • ReweightingLayer
    • ReweightingSchema
    • default_storage_query
    • CalculationBackend
    • ComputeResources
    • QueueWorkerResources
    • BaseDaskBackend
    • BaseDaskJobQueueBackend
    • DaskLocalCluster
    • DaskLSFBackend
    • DaskPBSBackend
    • StorageBackend
    • LocalFileStorage
    • BaseStoredData
    • HashableStoredData
    • ForceFieldData
    • ReplaceableData
    • BaseSimulationData
    • StoredSimulationData
    • StoredFreeEnergyData
    • BaseDataQuery
    • SubstanceQuery
    • ForceFieldQuery
    • BaseSimulationDataQuery
    • SimulationDataQuery
    • FreeEnergyDataQuery
    • FilePath
    • StorageAttribute
    • QueryAttribute
    • Workflow
    • WorkflowException
    • WorkflowGraph
    • WorkflowResult
    • Protocol
    • ProtocolGraph
    • ProtocolGroup
    • workflow_protocol
    • register_workflow_protocol
    • ProtocolSchema
    • ProtocolGroupSchema
    • ProtocolReplicator
    • WorkflowSchema
    • BaseMergeBehavior
    • MergeBehavior
    • InequalityMergeBehavior
    • InputAttribute
    • OutputAttribute
    • ReplicatorValue
    • ProtocolPath
    • BaseAverageObservable
    • AverageObservable
    • AverageDielectricConstant
    • AverageFreeEnergies
    • ComputeDipoleMoments
    • BaseDecorrelateProtocol
    • DecorrelateTrajectory
    • DecorrelateObservables
    • BuildCoordinatesPackmol
    • SolvateExistingStructure
    • BuildDockedCoordinates
    • BaseBuildSystem
    • BuildSmirnoffSystem
    • BuildLigParGenSystem
    • BuildTLeapSystem
    • ZeroGradients
    • ConditionalGroup
    • AddValues
    • SubtractValues
    • MultiplyValue
    • DivideValue
    • WeightByMoleFraction
    • FilterSubstanceByRole
    • DummyProtocol
    • OpenMMEnergyMinimisation
    • OpenMMSimulation
    • OpenMMEvaluateEnergies
    • PreparePullCoordinates
    • PrepareReleaseCoordinates
    • AddDummyAtoms
    • GenerateAttachRestraints
    • GeneratePullRestraints
    • GenerateReleaseRestraints
    • ApplyRestraints
    • AnalyzeAPRPhase
    • ComputeSymmetryCorrection
    • ComputeReferenceWork
    • ConcatenateTrajectories
    • ConcatenateObservables
    • BaseEvaluateEnergies
    • BaseMBARProtocol
    • ReweightObservable
    • ReweightDielectricConstant
    • BaseEnergyMinimisation
    • BaseSimulation
    • UnpackStoredSimulationData
    • BaseYankProtocol
    • LigandReceptorYankProtocol
    • SolvationYankProtocol
    • SimulationProtocols
    • ReweightingProtocols
    • generate_base_reweighting_protocols
    • generate_reweighting_protocols
    • generate_simulation_protocols
    • Attribute
    • AttributeClass
    • UNDEFINED
    • PlaceholderValue
    • Observable
    • ObservableArray
    • ObservableType
    • ObservableFrame
    • bootstrap
    • register_default_plugins
    • register_external_plugins
  • Release History
  • Release Process

generate_reweighting_protocols

openff.evaluator.protocols.utils.generate_reweighting_protocols(observable_type: ObservableType, replicator_id: str = 'data_replicator', id_suffix: str = '') → Tuple[ReweightingProtocols[AverageObservable, ReweightObservable], ProtocolReplicator][source]
generate_base_reweighting_protocols
generate_simulation_protocols
© Copyright 2019, Open Force Field Consortium..
Created using Sphinx 4.5.0. and the Open Force Field Sphinx theme

An Open Force Field Initiative project.