Skip to content

Commit

Permalink
added missing units
Browse files Browse the repository at this point in the history
  • Loading branch information
jrudz committed Sep 13, 2024
1 parent 12167c8 commit 87058bc
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions simulationworkflowschema/molecular_dynamics.py
Original file line number Diff line number Diff line change
Expand Up @@ -2267,18 +2267,19 @@ class FreeEnergyCalculations(TrajectoryProperty):
""",
)

value_unit = Quantity(
type=str,
shape=[],
description="""
Unit of the property, using UnitRegistry() notation.
In this case, the unit corresponds to all `value` properties stored within this section.
""",
)
# value_unit = Quantity(
# type=str,
# shape=[],
# description="""
# Unit of the property, using UnitRegistry() notation.
# In this case, the unit corresponds to all `value` properties stored within this section.
# """,
# )

value_total_energy_magnitude = Quantity(
type=HDF5Dataset,
shape=[],
unit='joule',
description="""
Value of the total energy for the present lambda state. The expected dimensions are ["n_frames"].
This quantity is a reference to the data (file+path), which is stored in an HDF5 file for efficiency.
Expand All @@ -2288,6 +2289,7 @@ class FreeEnergyCalculations(TrajectoryProperty):
value_PV_energy_magnitude = Quantity(
type=HDF5Dataset,
shape=[],
unit='joule',
description="""
Value of the pressure-volume energy (i.e., P*V) for the present lambda state. The expected dimensions are ["n_frames"].
This quantity is a reference to the data (file+path), which is stored in an HDF5 file for efficiency.
Expand All @@ -2297,6 +2299,7 @@ class FreeEnergyCalculations(TrajectoryProperty):
value_total_energy_differences_magnitude = Quantity(
type=HDF5Dataset,
shape=[],
unit='joule',
description="""
Values correspond to the difference in total energy between each specified lambda state
and the reference state, which corresponds to the value of lambda of the current simulation.
Expand All @@ -2308,6 +2311,7 @@ class FreeEnergyCalculations(TrajectoryProperty):
value_total_energy_derivative_magnitude = Quantity(
type=HDF5Dataset,
shape=[],
unit='joule', # TODO check this unit
description="""
Value of the derivative of the total energy with respect to lambda, evaluated for the current
lambda state. The expected dimensions are ["n_frames"].
Expand Down

0 comments on commit 87058bc

Please sign in to comment.