def test_contains():
    """Test contains logic."""
    int_bounds = IntegerBounds(0, 2)

    assert int_bounds.contains(IntegerBounds(0, 1))
    assert int_bounds.contains(IntegerBounds(1, 2))
    assert not int_bounds.contains(IntegerBounds(1, 3))
    assert not int_bounds.contains(None)
    with pytest.raises(TypeError):
        int_bounds.contains([0, 1])

    from gemd.entity.value import NominalInteger

    assert int_bounds.contains(NominalInteger(1))
    assert not int_bounds.contains(NominalInteger(5))
Beispiel #2
0
def make_value(value: Union[str, float, int],
               bounds: BaseBounds) -> BaseValue:
    """
    Generate a Value object based upon a number or string and a particular bounds.

    Parameters
    ----------
    value: Union[str, float, int]
        The primitive type to wrap in a Value
    bounds: BaseBounds
        The bounds type to determine which value type we want to coerce the value into

    Returns
    --------
    BaseValue
        The generated value

    """
    if isinstance(bounds, RealBounds):
        result = NominalReal(value, units=bounds.default_units)
    elif isinstance(bounds, IntegerBounds):
        result = NominalInteger(value)
    elif isinstance(bounds, CategoricalBounds):
        result = NominalCategorical(value)
    elif isinstance(bounds, CompositionBounds):
        result = EmpiricalFormula(value)
    elif isinstance(bounds, MolecularStructureBounds):
        if str(value).startswith("InChI="):
            result = InChI(value)
        else:
            result = Smiles(value)
    else:
        raise ValueError(f"Unrecognized bound type in template {type(bounds)}")

    return result
def test_dependencies():
    """Test that dependency lists make sense."""
    prop = PropertyTemplate(name="name", bounds=IntegerBounds(0, 1))
    cond = ConditionTemplate(name="name", bounds=IntegerBounds(0, 1))

    template = MaterialTemplate("measurement template")
    spec = MaterialSpec("A spec", template=template,
                        properties=[PropertyAndConditions(
                            property=Property("name", template=prop, value=NominalInteger(1)),
                            conditions=[
                                Condition("name", template=cond, value=NominalInteger(1))
                            ]
                        )])

    assert template in spec.all_dependencies()
    assert cond in spec.all_dependencies()
    assert prop in spec.all_dependencies()
Beispiel #4
0
def test_dependencies():
    """Test that dependency lists make sense."""
    prop = PropertyTemplate(name="name", bounds=IntegerBounds(0, 1))
    cond = ConditionTemplate(name="name", bounds=IntegerBounds(0, 1))
    param = ParameterTemplate(name="name", bounds=IntegerBounds(0, 1))

    template = MeasurementTemplate("measurement template",
                                   parameters=[param],
                                   conditions=[cond],
                                   properties=[prop])
    spec = MeasurementSpec("A spec", template=template)
    mat = MaterialRun(name="mr")
    meas = MeasurementRun("A run",
                          spec=spec,
                          material=mat,
                          properties=[
                              Property(prop.name,
                                       template=prop,
                                       value=NominalInteger(1))
                          ],
                          conditions=[
                              Condition(cond.name,
                                        template=cond,
                                        value=NominalInteger(1))
                          ],
                          parameters=[
                              Parameter(param.name,
                                        template=param,
                                        value=NominalInteger(1))
                          ])

    assert template not in meas.all_dependencies()
    assert spec in meas.all_dependencies()
    assert mat in meas.all_dependencies()
    assert prop in meas.all_dependencies()
    assert cond in meas.all_dependencies()
    assert param in meas.all_dependencies()
Beispiel #5
0
def test_contains():
    """Test basic contains logic."""
    bounds = MolecularStructureBounds()
    assert bounds.contains(MolecularStructureBounds())
    assert not bounds.contains(RealBounds(0.0, 2.0, ''))
    assert not bounds.contains(None)
    with pytest.raises(TypeError):
        bounds.contains('c1(C=O)cc(OC)c(O)cc1')
    with pytest.raises(TypeError):
        bounds.contains(
            'InChI=1/C8H8O3/c1-11-8-4-6(5-9)2-3-7(8)10/h2-5,10H,1H3')

    from gemd.entity.value import Smiles, NominalInteger

    assert bounds.contains(Smiles('c1(C=O)cc(OC)c(O)cc1'))
    assert not bounds.contains(NominalInteger(5))
def test_mat_spec_properties(caplog):
    """Make sure template validations and level controls behave as expected."""
    prop_tmpl = PropertyTemplate("Name", bounds=IntegerBounds(0, 2))
    cond_tmpl = ConditionTemplate("Name", bounds=IntegerBounds(0, 2))
    mat_tmpl = MaterialTemplate("Material Template", properties=[[prop_tmpl, IntegerBounds(0, 1)]])
    mat_spec = MaterialSpec("Material Spec", template=mat_tmpl)
    good_prop = PropertyAndConditions(
        property=Property("Name", value=NominalInteger(1), template=prop_tmpl),
        conditions=[Condition("Name", value=NominalInteger(1), template=cond_tmpl)]
    )
    bad_prop = PropertyAndConditions(
        property=Property("Name", value=NominalInteger(2), template=prop_tmpl),
        conditions=[Condition("Name", value=NominalInteger(1), template=cond_tmpl)]
    )
    bad_cond = PropertyAndConditions(  # This will pass since we don't have a condition constraint
        property=Property("Name", value=NominalInteger(1), template=prop_tmpl),
        conditions=[Condition("Name", value=NominalInteger(2), template=cond_tmpl)]
    )
    with validation_level(WarningLevel.IGNORE):
        mat_spec.properties.append(good_prop)
        assert len(caplog.records) == 0, "Warning encountered on IGNORE"
        mat_spec.properties.append(bad_prop)
        assert len(caplog.records) == 0, "Warning encountered on IGNORE"
        mat_spec.properties.append(bad_cond)
        assert len(caplog.records) == 0, "Warning encountered on IGNORE"
    with validation_level(WarningLevel.WARNING):
        mat_spec.properties.append(good_prop)
        assert len(caplog.records) == 0, "Warning encountered on Good value"
        mat_spec.properties.append(bad_prop)
        assert len(caplog.records) == 1, "No warning encountered on Bad Value"
        mat_spec.properties.append(bad_cond)
        assert len(caplog.records) == 1, "Warning encountered on Bad condition"
    with validation_level(WarningLevel.FATAL):
        mat_spec.properties.append(good_prop)  # This is fine
        with pytest.raises(ValueError):
            mat_spec.properties.append(bad_prop)
        mat_spec.properties.append(bad_cond)  # This should probably not be fine
Beispiel #7
0
def test_links_as_templates():
    """Verify that LinkByUIDs don't break anything we could have otherwise done."""
    prop_tmpl = PropertyTemplate("Name",
                                 uids={"scope": "prop"},
                                 bounds=IntegerBounds(1, 5))
    cond_tmpl = ConditionTemplate("Name",
                                  uids={"scope": "cond"},
                                  bounds=IntegerBounds(1, 5))
    param_tmpl = ParameterTemplate("Name",
                                   uids={"scope": "param"},
                                   bounds=IntegerBounds(1, 5))
    no_bounds = MeasurementTemplate(
        "Name",
        properties=[prop_tmpl],
        conditions=[cond_tmpl],
        parameters=[param_tmpl],
    )

    just_right = NominalInteger(2)
    middling = NominalInteger(4)
    too_high = NominalInteger(7)

    scenarios = [
        ("property", Property, MeasurementTemplate.validate_property,
         prop_tmpl),
        ("condition", Condition, MeasurementTemplate.validate_condition,
         cond_tmpl),
        ("parameter", Parameter, MeasurementTemplate.validate_parameter,
         param_tmpl),
    ]

    # Check that Attributes are checked against the template when the attributes links
    for scenario in scenarios:
        name, attr, validate, tmpl = scenario

        assert validate(no_bounds,
                        attr("Other name", template=tmpl.to_link(), value=middling)), \
            f"{name} didn't validate with {name}.template as LinkByUID."
        assert not validate(no_bounds,
                            attr("Other name", template=tmpl.to_link(), value=too_high)), \
            f"{name} DID validate with {name}.template as LinkByUID and bad value."

    with_bounds = MeasurementTemplate(
        "Name",
        properties=[(prop_tmpl.to_link(), IntegerBounds(1, 3))],
        conditions=[(cond_tmpl.to_link(), IntegerBounds(1, 3))],
        parameters=[(param_tmpl.to_link(), IntegerBounds(1, 3))],
    )

    # Check that Attributes are checked against the bounds when the attributes links
    for scenario in scenarios:
        name, attr, validate, tmpl = scenario

        assert validate(with_bounds,
                        attr("Other name", template=tmpl.to_link(), value=just_right)), \
            f"{name} didn't validate with {name}.template as LinkByUID and bounds."
        assert not validate(with_bounds,
                            attr("Other name", template=tmpl.to_link(), value=middling)), \
            f"{name} DID validate with {name}.template as LinkByUID, bad value, and bounds."

    with_links = MeasurementTemplate(
        "Name",
        properties=[(prop_tmpl.to_link())],
        conditions=[(cond_tmpl.to_link())],
        parameters=[(param_tmpl.to_link())],
    )

    # Check that tests pass when there's no way to test
    for scenario in scenarios:
        name, attr, validate, tmpl = scenario

        assert validate(with_links,
                        attr("Other name", template=tmpl.to_link(), value=too_high)), \
            f"{name} didn't validate with LinkByUID for everything."
Beispiel #8
0
def test_mixins():
    """Measurement templates have all 3 mixin traits."""
    obj = MeasurementTemplate(
        "Name",
        properties=[PropertyTemplate("Name", bounds=IntegerBounds(0, 1))],
        conditions=[ConditionTemplate("Name", bounds=IntegerBounds(0, 1))],
        parameters=[ParameterTemplate("Name", bounds=IntegerBounds(0, 1))],
    )
    with pytest.raises(TypeError):
        obj.properties.append(
            ConditionTemplate("3", bounds=IntegerBounds(0, 5)))
    with pytest.raises(TypeError):
        obj.properties.append(
            ParameterTemplate("3", bounds=IntegerBounds(0, 5)))

    with pytest.raises(TypeError):
        obj.conditions.append(PropertyTemplate("3", bounds=IntegerBounds(0,
                                                                         5)))
    with pytest.raises(TypeError):
        obj.conditions.append(
            ParameterTemplate("3", bounds=IntegerBounds(0, 5)))

    with pytest.raises(TypeError):
        obj.parameters.append(
            ConditionTemplate("3", bounds=IntegerBounds(0, 5)))
    with pytest.raises(TypeError):
        obj.parameters.append(PropertyTemplate("3", bounds=IntegerBounds(0,
                                                                         5)))

    with pytest.raises(TypeError):  # You passed a `scalar` to extend
        obj.properties.extend((PropertyTemplate("3",
                                                bounds=IntegerBounds(0, 5)),
                               IntegerBounds(1, 3)))

    with pytest.raises(ValueError):  # You passed a `scalar` to extend
        obj.properties = (PropertyTemplate("3", bounds=IntegerBounds(1, 3)),
                          IntegerBounds(0, 5))

    obj.properties.append(
        (PropertyTemplate("2", bounds=IntegerBounds(0,
                                                    5)), IntegerBounds(1, 3)))
    obj.properties.extend([
        PropertyTemplate("3", bounds=IntegerBounds(0, 5)),
        (PropertyTemplate("4", bounds=IntegerBounds(0,
                                                    5)), IntegerBounds(1, 3))
    ])
    obj.conditions.insert(1, ConditionTemplate("2", bounds=IntegerBounds(0,
                                                                         1)))
    obj.parameters[0] = ParameterTemplate("Name", bounds=IntegerBounds(0, 1))

    for x in (obj.properties, obj.conditions, obj.parameters):
        assert isinstance(x, ValidList)
        for y in x:
            assert isinstance(y, list)
            assert len(y) == 2
            assert isinstance(y[0], AttributeTemplate)
            if y[1] is not None:
                assert isinstance(y[1], BaseBounds)

    second = MeasurementTemplate(
        "Name",
        properties=[
            PropertyTemplate("Name", bounds=IntegerBounds(0, 1)),
            IntegerBounds(0, 1)
        ],
        conditions=[
            ConditionTemplate("Name", bounds=IntegerBounds(0, 1)),
            IntegerBounds(0, 1)
        ],
        parameters=[
            ParameterTemplate("Name", bounds=IntegerBounds(0, 1)),
            IntegerBounds(0, 1)
        ],
    )
    assert len(second.properties) == 1
    assert len(second.conditions) == 1
    assert len(second.parameters) == 1

    good_val = NominalInteger(1)
    bad_val = NominalInteger(2)

    assert second.validate_condition(Condition("Other name",
                                               value=good_val,
                                               template=second.conditions[0][0])), \
        "Condition with template and good value didn't validate."
    assert not second.validate_condition(Condition("Other name",
                                                   value=bad_val,
                                                   template=second.conditions[0][0])), \
        "Condition with template and bad value DID validate."
    assert second.validate_parameter(Parameter("Other name",
                                               value=good_val,
                                               template=second.parameters[0][0])), \
        "Parameter with template and good value didn't validate."
    assert not second.validate_parameter(Parameter("Other name",
                                                   value=bad_val,
                                                   template=second.parameters[0][0])), \
        "Parameter with template and bad value DID validate."
    assert second.validate_property(Property("Other name",
                                             value=good_val,
                                             template=second.properties[0][0])), \
        "Property with template and good value didn't validate."
    assert not second.validate_property(Property("Other name",
                                                 value=bad_val,
                                                 template=second.properties[0][0])), \
        "Property with template and bad value DID validate."

    assert second.validate_condition(Condition("Name", value=good_val)), \
        "Condition without template and good value didn't validate."
    assert not second.validate_condition(Condition("Name", value=bad_val)), \
        "Condition without template and bad value DID validate."
    assert second.validate_parameter(Parameter("Name", value=good_val)), \
        "Parameter without template and good value didn't validate."
    assert not second.validate_parameter(Parameter("Name", value=bad_val)), \
        "Parameter without template and bad value DID validate."
    assert second.validate_property(Property("Name", value=good_val)), \
        "Property without template and good value didn't validate."
    assert not second.validate_property(Property("Name", value=bad_val)), \
        "Property without template and bad value DID validate."

    assert second.validate_condition(Condition("Other name", value=bad_val)), \
        "Unmatched condition and bad value didn't validate."
    assert second.validate_parameter(Parameter("Other name", value=bad_val)), \
        "Unmatched parameter and bad value didn't validate."
    assert second.validate_property(Property("Other name", value=bad_val)), \
        "Unmatched property and bad value didn't validate."

    second.conditions[0][1] = None
    second.parameters[0][1] = None
    second.properties[0][1] = None
    assert second.validate_condition(Condition("Name", value=good_val)), \
        "Condition and good value with passthrough didn't validate."
    assert second.validate_parameter(Parameter("Name", value=good_val)), \
        "Parameter and good value with passthrough didn't validate."
    assert second.validate_property(Property("Name", value=good_val)), \
        "Property and good value with passthrough didn't validate."
    assert second.validate_property(
        PropertyAndConditions(property=Property("Name", value=good_val))), \
        "PropertyAndConditions didn't fall back to Property."
Beispiel #9
0
def make_cake(seed=None, tmpl=None, cake_spec=None, toothpick_img=None):
    """Define all objects that go into making a demo cake."""
    import struct
    import hashlib

    if seed is not None:
        random.seed(seed)
    # Code to generate quasi-repeatable run annotations
    # Note there are potential machine dependencies
    md5 = hashlib.md5()
    for x in random.getstate()[1]:
        md5.update(struct.pack(">I", x))
    run_key = md5.hexdigest()

    ######################################################################
    # Parent Objects
    if tmpl is None:
        tmpl = make_cake_templates()
    if cake_spec is None:
        cake_spec = make_cake_spec(tmpl)

    ######################################################################
    # Objects
    cake_obj = make_instance(cake_spec)
    operators = ['gwash', 'jadams', 'thomasj', 'jmadison', 'jmonroe']
    producers = ['Fresh Farm', 'Sunnydale', 'Greenbrook']
    drygoods = ['Acme', 'A1', 'Reliable', "Big Box"]
    cake_obj.process.source = PerformedSource(
        performed_by=random.choice(operators), performed_date='2015-03-14')

    def _randomize_object(item):
        # Add in the randomized particular values
        if not isinstance(item, (MaterialRun, ProcessRun, IngredientRun)):
            return

        item.add_uid(DEMO_SCOPE, '{}-{}'.format(item.spec.uids[DEMO_SCOPE],
                                                run_key))
        if item.spec.tags is not None:
            item.tags = list(item.spec.tags)
        if item.spec.notes:  # Neither None or empty string
            item.notes = 'The spec says "{}"'.format(item.spec.notes)
        if isinstance(item, MaterialRun):
            if 'raw material' in item.tags:
                if 'produce' in item.tags:
                    supplier = random.choice(producers)
                else:
                    supplier = random.choice(drygoods)
                item.name = "{} {}".format(supplier, item.spec.name)
        if isinstance(item, ProcessRun):
            if item.template.name == "Procuring":
                item.source = PerformedSource(performed_by='hamilton',
                                              performed_date='2015-02-17')
                item.name = "{} {}".format(item.template.name,
                                           item.output_material.name)
            else:
                item.source = cake_obj.process.source
        if isinstance(item, IngredientRun):
            fuzz = 0.95 + 0.1 * random.random()
            if item.spec.absolute_quantity is not None:
                item.absolute_quantity = \
                    NormalReal(mean=fuzz * item.spec.absolute_quantity.nominal,
                               std=0.05 * item.spec.absolute_quantity.nominal,
                               units=item.spec.absolute_quantity.units)
            if item.spec.volume_fraction is not None:
                # The only element here is dry mix, and it's almost entirely flour
                item.volume_fraction = \
                    NormalReal(mean=0.01 * (fuzz - 0.5) + item.spec.volume_fraction.nominal,
                               std=0.005,
                               units=item.spec.volume_fraction.units)
            if item.spec.mass_fraction is not None:
                item.mass_fraction = \
                    UniformReal(lower_bound=(fuzz - 0.05) * item.spec.mass_fraction.nominal,
                                upper_bound=(fuzz + 0.05) * item.spec.mass_fraction.nominal,
                                units=item.spec.mass_fraction.units)
            if item.spec.number_fraction is not None:
                item.number_fraction = \
                    NormalReal(mean=fuzz * item.spec.number_fraction.nominal,
                               std=0.05 * item.spec.number_fraction.nominal,
                               units=item.spec.number_fraction.units)

    recursive_foreach(cake_obj, _randomize_object)

    frosting = \
        next(x.material for x in cake_obj.process.ingredients if 'rosting' in x.name)
    baked = \
        next(x.material for x in cake_obj.process.ingredients if 'aked' in x.name)

    def _find_name(name, material):
        """Recursively search for the right material."""
        if name in material.name:
            return material
        for ingredient in material.process.ingredients:
            result = _find_name(name, ingredient.material)
            if result:
                return result
        return

    flour = _find_name('Flour', cake_obj)
    salt = _find_name('Salt', cake_obj)
    sugar = _find_name('Sugar', cake_obj)

    # Add measurements
    cake_taste = MeasurementRun(name='Final Taste', material=cake_obj)
    cake_appearance = MeasurementRun(name='Final Appearance',
                                     material=cake_obj)
    frosting_taste = MeasurementRun(name='Frosting Taste', material=frosting)
    frosting_sweetness = MeasurementRun(name='Frosting Sweetness',
                                        material=frosting)
    baked_doneness = MeasurementRun(name='Baking doneness', material=baked)
    flour_content = MeasurementRun(name='Flour nutritional analysis',
                                   material=flour)
    salt_content = MeasurementRun(name='Salt elemental analysis',
                                  material=salt)
    sugar_content = MeasurementRun(name='Sugar elemental analysis',
                                   material=sugar)

    if toothpick_img is not None:
        baked_doneness.file_links.append(toothpick_img)

    # and spec out the measurements
    cake_taste.spec = MeasurementSpec(name='Taste',
                                      template=tmpl['Taste test'])
    cake_appearance.spec = MeasurementSpec(name='Appearance')
    frosting_taste.spec = cake_taste.spec  # Taste
    frosting_sweetness.spec = MeasurementSpec(name='Sweetness')
    baked_doneness.spec = MeasurementSpec(name='Doneness',
                                          template=tmpl["Doneness"])
    flour_content.spec = MeasurementSpec(name='Nutritional analysis',
                                         template=tmpl["Nutritional Analysis"])
    salt_content.spec = MeasurementSpec(name='Elemental analysis',
                                        template=tmpl["Elemental Analysis"])
    sugar_content.spec = salt_content.spec

    # Note that while specs are regenerated each make_cake invocation, they are all identical
    for msr in (cake_taste, cake_appearance, frosting_taste,
                frosting_sweetness, baked_doneness, flour_content,
                salt_content, sugar_content):
        msr.spec.add_uid(DEMO_SCOPE, msr.spec.name.lower())
        msr.add_uid(
            DEMO_SCOPE,
            '{}--{}-{}'.format(msr.spec.uids[DEMO_SCOPE],
                               msr.material.spec.uids[DEMO_SCOPE], run_key))

    ######################################################################
    # Let's add some attributes
    baked.process.conditions.append(
        Condition(name='Cooking time',
                  template=tmpl['Cooking time'],
                  origin=Origin.MEASURED,
                  value=NominalReal(nominal=48, units='min')))
    baked.process.conditions.append(
        Condition(name='Oven temperature',
                  origin="measured",
                  value=NominalReal(nominal=362, units='degF')))

    cake_taste.properties.append(
        Property(name='Tastiness',
                 origin=Origin.MEASURED,
                 template=tmpl['Tastiness'],
                 value=UniformInteger(4, 5)))
    cake_appearance.properties.append(
        Property(name='Visual Appeal',
                 origin=Origin.MEASURED,
                 value=NominalInteger(nominal=5)))
    frosting_taste.properties.append(
        Property(name='Tastiness',
                 origin=Origin.MEASURED,
                 template=tmpl['Tastiness'],
                 value=NominalInteger(nominal=4)))
    frosting_sweetness.properties.append(
        Property(name='Sweetness (Sucrose-basis)',
                 origin=Origin.MEASURED,
                 value=NominalReal(nominal=1.7, units='')))

    baked_doneness.properties.append(
        Property(name='Toothpick test',
                 origin="measured",
                 template=tmpl["Toothpick test"],
                 value=NominalCategorical("crumbs")))
    baked_doneness.properties.append(
        Property(name='Color',
                 origin="measured",
                 template=tmpl["Color"],
                 value=DiscreteCategorical({
                     "Pale": 0.05,
                     "Golden brown": 0.65,
                     "Deep brown": 0.3
                 })))

    flour_content.properties.append(
        Property(name='Nutritional Information',
                 value=NominalComposition({
                     "dietary-fiber":
                     1 * (0.99 + 0.02 * random.random()),
                     "sugars":
                     1 * (0.99 + 0.02 * random.random()),
                     "other-carbohydrate":
                     20 * (0.99 + 0.02 * random.random()),
                     "protein":
                     4 * (0.99 + 0.02 * random.random()),
                     "other":
                     4 * (0.99 + 0.02 * random.random())
                 }),
                 template=tmpl["Nutritional Information"],
                 origin="measured"))
    flour_content.conditions.append(
        Condition(name='Sample Mass',
                  value=NormalReal(mean=99 + 2 * random.random(),
                                   std=1.5,
                                   units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="measured"))
    flour_content.parameters.append(
        Parameter(name='Expected Sample Mass',
                  value=NominalReal(nominal=0.1, units='g'),
                  template=tmpl["Expected Sample Mass"],
                  origin="specified"))
    flour_content.spec.conditions.append(
        Condition(name='Sample Mass',
                  value=NominalReal(nominal=100, units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="specified"))
    flour_content.spec.parameters.append(
        Parameter(name='Expected Sample Mass',
                  value=NominalReal(nominal=0.1, units='g'),
                  template=tmpl["Expected Sample Mass"],
                  origin="specified"))

    salt_content.properties.append(
        Property(name="Composition",
                 value=EmpiricalFormula(
                     formula="NaClCa0.006Si0.006O0.018K0.000015I0.000015"),
                 template=tmpl["Chemical Formula"],
                 origin="measured"))
    salt_content.conditions.append(
        Condition(name='Sample Mass',
                  value=NormalReal(mean=99 + 2 * random.random(),
                                   std=1.5,
                                   units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="measured"))
    salt_content.parameters.append(
        Parameter(name='Expected Sample Mass',
                  value=NominalReal(nominal=0.1, units='g'),
                  template=tmpl["Expected Sample Mass"],
                  origin="specified"))
    salt_content.spec.conditions.append(
        Condition(name='Sample Mass',
                  value=NominalReal(nominal=100, units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="specified"))

    sugar_content.properties.append(
        Property(
            name="Composition",
            value=EmpiricalFormula(formula='C11.996H21.995O10.997S0.00015'),
            template=tmpl["Chemical Formula"],
            origin="measured"))
    sugar_content.conditions.append(
        Condition(name='Sample Mass',
                  value=NormalReal(mean=99 + 2 * random.random(),
                                   std=1.5,
                                   units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="measured"))
    sugar_content.spec.parameters.append(
        Parameter(name='Expected Sample Mass',
                  value=NominalReal(nominal=0.1, units='g'),
                  template=tmpl["Expected Sample Mass"],
                  origin="specified"))

    cake_obj.notes = cake_obj.notes + "; Très délicieux! 😀"
    cake_obj.file_links = [
        FileLink(
            filename="Photo",
            url='https://storcpdkenticomedia.blob.core.windows.net/media/'
            'recipemanagementsystem/media/recipe-media-files/recipes/retail/x17/'
            '16730-beckys-butter-cake-600x600.jpg?ext=.jpg')
    ]

    return cake_obj
Beispiel #10
0
def make_cake_spec(tmpl=None):
    """Define a recipe for making a cake."""
    ###############################################################################################
    # Templates
    if tmpl is None:
        tmpl = make_cake_templates()

    def _make_ingredient(*, material, process, **kwargs):
        """Convenience method to utilize material fields in creating an ingredient's arguments."""
        return IngredientSpec(name=material.name.lower(),
                              tags=list(material.tags),
                              material=material,
                              process=process,
                              uids={
                                  DEMO_SCOPE:
                                  "{}--{}".format(material.uids[DEMO_SCOPE],
                                                  process.uids[DEMO_SCOPE])
                              },
                              **kwargs)

    def _make_material(*, material_name, template, process_tmpl_name,
                       process_kwargs, **material_kwargs):
        """Convenience method to reuse material name in creating a material's arguments."""
        process_name = "{} {}".format(process_tmpl_name, material_name)
        return MaterialSpec(
            name=material_name,
            uids={DEMO_SCOPE: material_name.lower().replace(' ', '-')},
            template=template,
            process=ProcessSpec(
                name=process_name,
                uids={DEMO_SCOPE: process_name.lower().replace(' ', '-')},
                template=tmpl[process_tmpl_name],
                **process_kwargs),
            **material_kwargs)

    ###############################################################################################
    # Objects
    cake_obj = _make_material(
        material_name="Cake",
        process_tmpl_name="Icing",
        process_kwargs={
            "tags": ['spreading'],
            "notes": 'The act of covering a baked output with frosting'
        },
        template=tmpl["Dessert"],
        properties=[
            PropertyAndConditions(
                Property(name="Tastiness",
                         value=NominalInteger(5),
                         template=tmpl["Tastiness"],
                         origin="specified"))
        ],
        file_links=FileLink(
            filename="Becky's Butter Cake",
            url='https://www.landolakes.com/recipe/16730/becky-s-butter-cake/'
        ),
        tags=['cake::butter cake', 'dessert::baked::cake', 'iced::chocolate'],
        notes=
        'Butter cake recipe reminiscent of the 1-2-3-4 cake that Grandma may have baked.'
    )

    ########################
    frosting = _make_material(
        material_name="Frosting",
        process_tmpl_name="Mixing",
        process_kwargs={
            "tags": ['mixing'],
            "parameters": [
                Parameter(name='Mixer speed setting',
                          template=tmpl['Mixer speed setting'],
                          origin='specified',
                          value=NominalInteger(2))
            ],
            "notes":
            'Combining ingredients to make a sweet frosting'
        },
        template=tmpl["Dessert"],
        tags=['frosting::chocolate', 'topping::chocolate'],
        notes='Chocolate frosting')
    _make_ingredient(material=frosting,
                     notes='Seems like a lot of frosting',
                     labels=['coating'],
                     process=cake_obj.process,
                     absolute_quantity=NominalReal(nominal=0.751, units='kg'))

    baked_cake = _make_material(
        material_name="Baked Cake",
        process_tmpl_name="Baking",
        process_kwargs={
            "tags": ['oven::baking'],
            "conditions": [
                Condition(name='Cooking time',
                          template=tmpl['Cooking time'],
                          origin=Origin.SPECIFIED,
                          value=NormalReal(mean=50, std=5, units='min'))
            ],
            "parameters": [
                Parameter(name='Oven temperature setting',
                          template=tmpl['Oven temperature setting'],
                          origin="specified",
                          value=NominalReal(nominal=350, units='degF'))
            ],
            "notes":
            'Using heat to convert batter into a solid matrix'
        },
        template=tmpl["Baked Good"],
        properties=[
            PropertyAndConditions(
                property=Property(name="Toothpick test",
                                  value=NominalCategorical("completely clean"),
                                  template=tmpl["Toothpick test"])),
            PropertyAndConditions(
                property=Property(name="Color",
                                  value=NominalCategorical("Golden brown"),
                                  template=tmpl["Color"],
                                  origin="specified"))
        ],
        tags=['substrate'],
        notes='The cakey part of the cake')
    _make_ingredient(material=baked_cake,
                     labels=['substrate'],
                     process=cake_obj.process)

    ########################
    batter = _make_material(
        material_name="Batter",
        process_tmpl_name="Mixing",
        process_kwargs={
            "tags": ['mixing'],
            "parameters": [
                Parameter(name='Mixer speed setting',
                          template=tmpl['Mixer speed setting'],
                          origin='specified',
                          value=NominalInteger(2))
            ],
            "notes":
            'Combining ingredients to make a baking feedstock'
        },
        template=tmpl["Generic Material"],
        tags=['mixture'],
        notes='The fluid that converts to cake with heat')
    _make_ingredient(material=batter,
                     labels=['precursor'],
                     process=baked_cake.process)

    ########################
    wetmix = _make_material(
        material_name="Wet Ingredients",
        process_tmpl_name="Mixing",
        process_kwargs={
            "tags": ['mixing'],
            "parameters": [
                Parameter(name='Mixer speed setting',
                          template=tmpl['Mixer speed setting'],
                          origin='specified',
                          value=NominalInteger(2))
            ],
            "notes":
            'Combining wet ingredients to make a baking feedstock'
        },
        template=tmpl["Generic Material"],
        tags=["mixture"],
        notes='The wet fraction of a batter')
    _make_ingredient(material=wetmix, labels=['wet'], process=batter.process)

    drymix = _make_material(
        material_name="Dry Ingredients",
        process_tmpl_name="Mixing",
        process_kwargs={
            "tags": ['mixing'],
            "notes": 'Combining dry ingredients to make a baking feedstock'
        },
        template=tmpl["Generic Material"],
        tags=["mixture"],
        notes='The dry fraction of a batter')
    _make_ingredient(material=drymix,
                     labels=['dry'],
                     process=batter.process,
                     absolute_quantity=NominalReal(nominal=3.052,
                                                   units='cups'))

    ########################
    flour = _make_material(
        material_name="Flour",
        process_tmpl_name="Procuring",
        process_kwargs={
            "tags": ['purchase::dry-goods'],
            "notes": 'Purchasing all purpose flour'
        },
        template=tmpl["Nutritional Material"],
        properties=[
            PropertyAndConditions(
                property=Property(name="Nutritional Information",
                                  value=NominalComposition({
                                      "dietary-fiber":
                                      1,
                                      "sugars":
                                      1,
                                      "other-carbohydrate":
                                      20,
                                      "protein":
                                      4,
                                      "other":
                                      4
                                  }),
                                  template=tmpl["Nutritional Information"],
                                  origin="specified"),
                conditions=Condition(name="Serving Size",
                                     value=NominalReal(30, 'g'),
                                     template=tmpl["Sample Mass"],
                                     origin="specified"))
        ],
        tags=['raw material', 'flour', 'dry-goods'],
        notes='All-purpose flour')
    _make_ingredient(
        material=flour,
        labels=['dry'],
        process=drymix.process,
        volume_fraction=NominalReal(nominal=0.9829, units='')  # 3 cups
    )

    baking_powder = _make_material(
        material_name="Baking Powder",
        process_tmpl_name="Procuring",
        process_kwargs={
            "tags": ['purchase::dry-goods'],
            "notes": 'Purchasing baking powder'
        },
        template=tmpl["Generic Material"],
        tags=['raw material', 'leavening', 'dry-goods'],
        notes='Leavening agent for cake')
    _make_ingredient(
        material=baking_powder,
        labels=['leavening', 'dry'],
        process=drymix.process,
        volume_fraction=NominalReal(nominal=0.0137, units='')  # 2 teaspoons
    )

    salt = _make_material(material_name="Salt",
                          process_tmpl_name="Procuring",
                          process_kwargs={
                              "tags": ['purchase::dry-goods'],
                              "notes": 'Purchasing salt'
                          },
                          template=tmpl["Formulaic Material"],
                          tags=['raw material', 'seasoning', 'dry-goods'],
                          notes='Plain old NaCl',
                          properties=[
                              PropertyAndConditions(
                                  Property(name='Formula',
                                           value=EmpiricalFormula("NaCl")))
                          ])
    _make_ingredient(
        material=salt,
        labels=['dry', 'seasoning'],
        process=drymix.process,
        volume_fraction=NominalReal(nominal=0.0034, units='')  # 1/2 teaspoon
    )

    sugar = _make_material(
        material_name="Sugar",
        process_tmpl_name="Procuring",
        process_kwargs={
            "tags": ['purchase::dry-goods'],
            "notes": 'Purchasing granulated sugar'
        },
        template=tmpl["Formulaic Material"],
        tags=['raw material', 'sweetener', 'dry-goods'],
        notes='Sugar',
        properties=[
            PropertyAndConditions(
                Property(name="Formula", value=EmpiricalFormula("C12H22O11"))),
            PropertyAndConditions(
                Property(name='SMILES',
                         value=Smiles(
                             "C(C1C(C(C(C(O1)OC2(C(C(C(O2)CO)O)O)CO)O)O)O)O"),
                         template=tmpl["Molecular Structure"]))
        ])
    _make_ingredient(material=sugar,
                     labels=['wet', 'sweetener'],
                     process=wetmix.process,
                     absolute_quantity=NominalReal(nominal=2, units='cups'))

    butter = _make_material(
        material_name="Butter",
        process_tmpl_name="Procuring",
        process_kwargs={
            "tags": ['purchase::produce'],
            "notes": 'Purchasing butter'
        },
        template=tmpl["Generic Material"],
        tags=['raw material', 'produce', 'shortening', 'dairy'],
        notes='Shortening for making rich, buttery baked goods')
    _make_ingredient(material=butter,
                     labels=['wet', 'shortening'],
                     process=wetmix.process,
                     absolute_quantity=NominalReal(nominal=1, units='cups'))
    _make_ingredient(
        material=butter,
        labels=['shortening'],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.1434,
                                  units='')  # 1/2 c @ 0.911 g/cc
    )

    eggs = _make_material(material_name="Eggs",
                          process_tmpl_name="Procuring",
                          process_kwargs={
                              "tags": ['purchase::produce'],
                              "notes": 'Purchasing eggs'
                          },
                          template=tmpl["Generic Material"],
                          tags=[
                              'raw material',
                              'produce',
                          ],
                          notes='A custard waiting to happen')
    _make_ingredient(material=eggs,
                     labels=['wet'],
                     process=wetmix.process,
                     absolute_quantity=NominalReal(nominal=4, units=''))

    vanilla = _make_material(
        material_name="Vanilla",
        process_tmpl_name="Procuring",
        process_kwargs={
            "tags": ['purchase::solution'],
            "notes": 'Purchasing vanilla'
        },
        template=tmpl["Generic Material"],
        tags=['raw material', 'seasoning'],
        notes=
        'Vanilla Extract is mostly alcohol but the most important component '
        'is vanillin (see attached structure)',
        properties=[
            PropertyAndConditions(
                Property(
                    name='Component Structure',
                    value=InChI(
                        "InChI=1S/C8H8O3/c1-11-8-4-6(5-9)2-3-7(8)10/h2-5,10H,1H3"
                    ),
                    template=tmpl["Molecular Structure"]))
        ])
    _make_ingredient(material=vanilla,
                     labels=['wet', 'flavoring'],
                     process=wetmix.process,
                     absolute_quantity=NominalReal(nominal=2,
                                                   units='teaspoons'))
    _make_ingredient(
        material=vanilla,
        labels=['flavoring'],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.0231,
                                  units='')  # 2 tsp @ 0.879 g/cc
    )

    milk = _make_material(material_name="Milk",
                          process_tmpl_name="Procuring",
                          process_kwargs={
                              "tags": ['purchase::produce'],
                              "notes": 'Purchasing milk'
                          },
                          template=tmpl["Generic Material"],
                          tags=['raw material', 'produce', 'dairy'],
                          notes='')
    _make_ingredient(material=milk,
                     labels=['wet'],
                     process=batter.process,
                     absolute_quantity=NominalReal(nominal=1, units='cup'))
    _make_ingredient(
        material=milk,
        labels=[],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.0816,
                                  units='')  # 1/4 c @ 1.037 g/cc
    )

    chocolate = _make_material(material_name="Chocolate",
                               process_tmpl_name="Procuring",
                               process_kwargs={
                                   "tags": ['purchase::dry-goods'],
                                   "notes": 'Purchasing chocolate'
                               },
                               template=tmpl["Generic Material"],
                               tags=['raw material'],
                               notes='')
    _make_ingredient(
        material=chocolate,
        labels=['flavoring'],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.1132, units='')  # 3 oz.
    )

    powder_sugar = _make_material(
        material_name="Powdered Sugar",
        process_tmpl_name="Procuring",
        process_kwargs={
            "tags": ['purchase::dry-goods'],
            "notes": 'Purchasing powdered sugar'
        },
        template=tmpl["Generic Material"],
        tags=['raw material', 'sweetener', 'dry-goods'],
        notes='Granulated sugar mixed with corn starch')
    _make_ingredient(
        material=powder_sugar,
        labels=['flavoring'],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.6387,
                                  units='')  # 4 c @ 30 g/ 0.25 cups
    )

    return cake_obj
Beispiel #11
0
def make_cake(seed=None, tmpl=None, cake_spec=None):
    """Define all objects that go into making a demo cake."""
    import struct
    import hashlib

    if seed is not None:
        random.seed(seed)
    ######################################################################
    # Parent Objects
    if tmpl is None:
        tmpl = make_cake_templates()
    if cake_spec is None:
        cake_spec = make_cake_spec(tmpl)

    ######################################################################
    # Objects
    cake = make_instance(cake_spec)
    operators = ['gwash', 'jadams', 'thomasj', 'jmadison', 'jmonroe']
    cake.process.source = PerformedSource(
        performed_by=random.choice(operators), performed_date='2015-03-14')
    # Replace Abstract/In General
    queue = [cake]
    while queue:
        item = queue.pop(0)
        if item.spec.tags is not None:
            item.tags = list(item.spec.tags)
        if item.spec.notes:  # None or empty string
            item.notes = 'The spec says "{}"'.format(item.spec.notes)

        if isinstance(item, MaterialRun):
            item.name = item.name.replace('Abstract ', '')
            queue.append(item.process)
        elif isinstance(item, ProcessRun):
            item.name = item.name.replace(', in General', '')
            queue.extend(item.ingredients)
            if item.template.name == "Procurement":
                item.source = PerformedSource(performed_by='hamilton',
                                              performed_date='2015-02-17')
            else:
                item.source = cake.process.source
        elif isinstance(item, IngredientRun):
            queue.append(item.material)
            fuzz = 0.95 + 0.1 * random.random()
            if item.spec.absolute_quantity is not None:
                item.absolute_quantity = \
                    NormalReal(mean=fuzz * item.spec.absolute_quantity.nominal,
                               std=0.05 * item.spec.absolute_quantity.nominal,
                               units=item.spec.absolute_quantity.units)
            if item.spec.volume_fraction is not None:
                # The only element here is dry mix, and it's almost entirely flour
                item.volume_fraction = \
                    NormalReal(mean=0.01 * (fuzz - 0.5) + item.spec.volume_fraction.nominal,
                               std=0.005,
                               units=item.spec.volume_fraction.units)
            if item.spec.mass_fraction is not None:
                item.mass_fraction = \
                    UniformReal(lower_bound=(fuzz - 0.05) * item.spec.mass_fraction.nominal,
                                upper_bound=(fuzz + 0.05) * item.spec.mass_fraction.nominal,
                                units=item.spec.mass_fraction.units)
            if item.spec.number_fraction is not None:
                item.number_fraction = \
                    NormalReal(mean=fuzz * item.spec.number_fraction.nominal,
                               std=0.05 * item.spec.number_fraction.nominal,
                               units=item.spec.number_fraction.units)

        else:
            raise TypeError("Unexpected object in the queue")

    frosting = \
        next(x.material for x in cake.process.ingredients if 'rosting' in x.name)
    baked = \
        next(x.material for x in cake.process.ingredients if 'aked' in x.name)

    def find_name(name, material):
        # Recursively search for the right material
        if name == material.name:
            return material
        for ingredient in material.process.ingredients:
            result = find_name(name, ingredient.material)
            if result:
                return result
        return

    flour = find_name('Flour', cake)
    salt = find_name('Salt', cake)
    sugar = find_name('Sugar', cake)

    # Add measurements
    cake_taste = MeasurementRun(name='Final Taste', material=cake)
    cake_appearance = MeasurementRun(name='Final Appearance', material=cake)
    frosting_taste = MeasurementRun(name='Frosting Taste', material=frosting)
    frosting_sweetness = MeasurementRun(name='Frosting Sweetness',
                                        material=frosting)
    baked_doneness = MeasurementRun(name='Baking doneness', material=baked)
    flour_content = MeasurementRun(name='Flour nutritional analysis',
                                   material=flour)
    salt_content = MeasurementRun(name='Salt elemental analysis',
                                  material=salt)
    sugar_content = MeasurementRun(name='Sugar elemental analysis',
                                   material=sugar)

    # and spec out the measurements
    cake_taste.spec = MeasurementSpec(name='Taste',
                                      template=tmpl['Taste test'])
    cake_appearance.spec = MeasurementSpec(name='Appearance')
    frosting_taste.spec = cake_taste.spec  # Taste
    frosting_sweetness.spec = MeasurementSpec(name='Sweetness')
    baked_doneness.spec = MeasurementSpec(name='Doneness',
                                          template=tmpl["Doneness"])
    flour_content.spec = MeasurementSpec(name='Nutritional analysis',
                                         template=tmpl["Nutritional Analysis"])
    salt_content.spec = MeasurementSpec(name='Elemental analysis',
                                        template=tmpl["Elemental Analysis"])
    sugar_content.spec = salt_content.spec

    for msr in (cake_taste, cake_appearance, frosting_taste,
                frosting_sweetness, baked_doneness, flour_content,
                salt_content, sugar_content):
        msr.spec.add_uid(DEMO_SCOPE, msr.spec.name)

    ######################################################################
    # Let's add some attributes
    baked.process.conditions.append(
        Condition(name='Cooking time',
                  template=tmpl['Cooking time'],
                  origin=Origin.MEASURED,
                  value=NominalReal(nominal=48, units='min')))
    baked.spec.process.conditions.append(
        Condition(name='Cooking time',
                  template=tmpl['Cooking time'],
                  origin=Origin.SPECIFIED,
                  value=NormalReal(mean=50, std=5, units='min')))
    baked.process.conditions.append(
        Condition(name='Oven temperature',
                  origin="measured",
                  value=NominalReal(nominal=362, units='degF')))
    baked.spec.process.parameters.append(
        Parameter(name='Oven temperature setting',
                  template=tmpl['Oven temperature setting'],
                  origin="specified",
                  value=NominalReal(nominal=350, units='degF')))
    cake_taste.properties.append(
        Property(name='Tastiness',
                 origin=Origin.MEASURED,
                 template=tmpl['Tastiness'],
                 value=UniformInteger(4, 5)))
    cake_appearance.properties.append(
        Property(name='Visual Appeal',
                 origin=Origin.MEASURED,
                 value=NominalInteger(nominal=5)))
    frosting_taste.properties.append(
        Property(name='Tastiness',
                 origin=Origin.MEASURED,
                 template=tmpl['Tastiness'],
                 value=NominalInteger(nominal=4)))
    frosting_sweetness.properties.append(
        Property(name='Sweetness (Sucrose-basis)',
                 origin=Origin.MEASURED,
                 value=NominalReal(nominal=1.7, units='')))

    baked_doneness.properties.append(
        Property(name='Toothpick test',
                 origin="measured",
                 template=tmpl["Toothpick test"],
                 value=NominalCategorical("crumbs")))
    baked_doneness.properties.append(
        Property(name='Color',
                 origin="measured",
                 template=tmpl["Color"],
                 value=DiscreteCategorical({
                     "Pale": 0.05,
                     "Golden brown": 0.65,
                     "Deep brown": 0.3
                 })))

    flour_content.properties.append(
        Property(name='Nutritional Information',
                 value=NominalComposition({
                     "dietary-fiber":
                     1 * (0.99 + 0.02 * random.random()),
                     "sugars":
                     1 * (0.99 + 0.02 * random.random()),
                     "other-carbohydrate":
                     20 * (0.99 + 0.02 * random.random()),
                     "protein":
                     4 * (0.99 + 0.02 * random.random()),
                     "other":
                     4 * (0.99 + 0.02 * random.random())
                 }),
                 template=tmpl["Nutritional Information"],
                 origin="measured"))
    flour_content.conditions.append(
        Condition(name='Sample Mass',
                  value=NormalReal(mean=99 + 2 * random.random(),
                                   std=1.5,
                                   units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="measured"))
    flour_content.parameters.append(
        Parameter(name='Expected Sample Mass',
                  value=NominalReal(nominal=0.1, units='g'),
                  template=tmpl["Expected Sample Mass"],
                  origin="specified"))
    flour_content.spec.conditions.append(
        Condition(name='Sample Mass',
                  value=NominalReal(nominal=100, units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="specified"))
    flour_content.spec.parameters.append(
        Parameter(name='Expected Sample Mass',
                  value=NominalReal(nominal=0.1, units='g'),
                  template=tmpl["Expected Sample Mass"],
                  origin="specified"))

    salt_content.properties.append(
        Property(name="Composition",
                 value=EmpiricalFormula(
                     formula="NaClCa0.006Si0.006O0.018K0.000015I0.000015"),
                 template=tmpl["Chemical Formula"],
                 origin="measured"))
    salt_content.conditions.append(
        Condition(name='Sample Mass',
                  value=NormalReal(mean=99 + 2 * random.random(),
                                   std=1.5,
                                   units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="measured"))
    salt_content.parameters.append(
        Parameter(name='Expected Sample Mass',
                  value=NominalReal(nominal=0.1, units='g'),
                  template=tmpl["Expected Sample Mass"],
                  origin="specified"))
    salt_content.spec.conditions.append(
        Condition(name='Sample Mass',
                  value=NominalReal(nominal=100, units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="specified"))

    sugar_content.properties.append(
        Property(
            name="Composition",
            value=EmpiricalFormula(formula='C11.996H21.995O10.997S0.00015'),
            template=tmpl["Chemical Formula"],
            origin="measured"))
    sugar_content.conditions.append(
        Condition(name='Sample Mass',
                  value=NormalReal(mean=99 + 2 * random.random(),
                                   std=1.5,
                                   units='mg'),
                  template=tmpl["Sample Mass"],
                  origin="measured"))
    sugar_content.spec.parameters.append(
        Parameter(name='Expected Sample Mass',
                  value=NominalReal(nominal=0.1, units='g'),
                  template=tmpl["Expected Sample Mass"],
                  origin="specified"))

    # Code to generate quasi-repeatable run annotations
    # Note there are potential machine dependencies
    md5 = hashlib.md5()
    for x in random.getstate()[1]:
        md5.update(struct.pack(">I", x))
    run_key = md5.hexdigest()

    # Crawl tree and annotate with uids; only add ids if there's nothing there
    recursive_foreach(
        cake,
        lambda obj: obj.uids or obj.add_uid(DEMO_SCOPE, obj.name + run_key))

    cake.notes = cake.notes + "; Très délicieux! 😀"
    cake.file_links = [
        FileLink(
            filename="Photo",
            url='https://www.landolakes.com/RecipeManagementSystem/media/'
            'Recipe-Media-Files/Recipes/Retail/x17/16730-beckys-butter-cake-600x600.jpg?ext=.jpg'
        )
    ]

    return cake
Beispiel #12
0
def make_cake_spec(tmpl=None):
    """Define a recipe for making a cake."""
    ###############################################################################################
    # Templates
    if tmpl is None:
        tmpl = make_cake_templates()

    count = dict()

    def ingredient_kwargs(material):
        # Pulls the elements of a material that all ingredients consume out
        count[material.name] = count.get(material.name, 0) + 1
        return {
            "name":
            "{} input{}".format(material.name.replace('Abstract ', ''),
                                " (Again)" * (count[material.name] - 1)),
            "tags":
            list(material.tags),
            "material":
            material
        }

    ###############################################################################################
    # Objects
    cake = MaterialSpec(
        name="Abstract Cake",
        template=tmpl["Dessert"],
        process=ProcessSpec(
            name='Icing Cake, in General',
            template=tmpl["Icing"],
            tags=['spreading'],
            notes='The act of covering a baked output with frosting'),
        properties=[
            PropertyAndConditions(
                Property(name="Tastiness",
                         value=NominalInteger(5),
                         template=tmpl["Tastiness"],
                         origin="specified"))
        ],
        file_links=FileLink(
            filename="Becky's Butter Cake",
            url='https://www.landolakes.com/recipe/16730/becky-s-butter-cake/'
        ),
        tags=['cake::butter cake', 'dessert::baked::cake', 'iced::chocolate'],
        notes=
        'Butter cake recipe reminiscent of the 1-2-3-4 cake that Grandma may have baked.'
    )

    ########################
    frosting = MaterialSpec(
        name="Abstract Frosting",
        template=tmpl["Dessert"],
        process=ProcessSpec(
            name='Mixing Frosting, in General',
            template=tmpl["Mixing"],
            tags=['mixing'],
            notes='Combining ingredients to make a sweet frosting'),
        tags=['frosting::chocolate', 'topping::chocolate'],
        notes='Chocolate frosting')
    IngredientSpec(**ingredient_kwargs(frosting),
                   notes='Seems like a lot of frosting',
                   labels=['coating'],
                   process=cake.process,
                   absolute_quantity=NominalReal(nominal=0.751, units='kg'))

    baked_cake = MaterialSpec(
        name="Abstract Baked Cake",
        template=tmpl["Generic Material"],
        process=ProcessSpec(
            name='Baking, in General',
            template=tmpl["Baking in an oven"],
            tags=['oven::baking'],
            notes='Using heat to convert batter into a solid matrix'),
        tags=[],
        notes='The cakey part of the cake')
    IngredientSpec(**ingredient_kwargs(baked_cake),
                   labels=['substrate'],
                   process=cake.process)

    ########################
    batter = MaterialSpec(
        name="Abstract Batter",
        template=tmpl["Generic Material"],
        process=ProcessSpec(
            name='Mixing Batter, in General',
            template=tmpl["Mixing"],
            tags=['mixing'],
            notes='Combining ingredients to make a baking feedstock'),
        tags=[],
        notes='The fluid that converts to cake with heat')
    IngredientSpec(**ingredient_kwargs(batter),
                   labels=['precursor'],
                   process=baked_cake.process)

    ########################
    wetmix = MaterialSpec(
        name="Abstract Wet Mix",
        template=tmpl["Generic Material"],
        process=ProcessSpec(
            name='Mixing Wet, in General',
            template=tmpl["Mixing"],
            tags=['mixing'],
            notes='Combining wet ingredients to make a baking feedstock'),
        tags=[],
        notes='The wet fraction of a batter')
    IngredientSpec(**ingredient_kwargs(wetmix),
                   labels=['wet'],
                   process=batter.process)

    drymix = MaterialSpec(
        name="Abstract Dry Mix",
        template=tmpl["Generic Material"],
        process=ProcessSpec(
            name='Mixing Dry, in General',
            template=tmpl["Mixing"],
            tags=['mixing'],
            notes='Combining dry ingredients to make a baking feedstock'),
        tags=[],
        notes='The dry fraction of a batter')
    IngredientSpec(**ingredient_kwargs(drymix),
                   labels=['dry'],
                   process=batter.process,
                   absolute_quantity=NominalReal(nominal=3.052, units='cups'))

    ########################
    flour = MaterialSpec(
        name="Abstract Flour",
        template=tmpl["Nutritional Material"],
        properties=[
            PropertyAndConditions(
                property=Property(name="Nutritional Information",
                                  value=NominalComposition({
                                      "dietary-fiber":
                                      1,
                                      "sugars":
                                      1,
                                      "other-carbohydrate":
                                      20,
                                      "protein":
                                      4,
                                      "other":
                                      4
                                  }),
                                  template=tmpl["Nutritional Information"],
                                  origin="specified"),
                conditions=Condition(name="Serving Size",
                                     value=NominalReal(30, 'g'),
                                     template=tmpl["Sample Mass"],
                                     origin="specified"))
        ],
        process=ProcessSpec(name='Buying Flour, in General',
                            template=tmpl["Procurement"],
                            tags=['purchase::dry-goods'],
                            notes='Purchasing all purpose flour'),
        tags=[],
        notes='All-purpose flour')
    IngredientSpec(
        **ingredient_kwargs(flour),
        labels=['dry'],
        process=drymix.process,
        volume_fraction=NominalReal(nominal=0.9829, units='')  # 3 cups
    )

    baking_powder = MaterialSpec(name="Abstract Baking Powder",
                                 template=tmpl["Generic Material"],
                                 process=ProcessSpec(
                                     name='Buying Baking Powder, in General',
                                     template=tmpl["Procurement"],
                                     tags=['purchase::dry-goods'],
                                     notes='Purchasing baking powder'),
                                 tags=[],
                                 notes='Leavening agent for cake')
    IngredientSpec(
        **ingredient_kwargs(baking_powder),
        labels=['leavening', 'dry'],
        process=drymix.process,
        volume_fraction=NominalReal(nominal=0.0137, units='')  # 2 teaspoons
    )

    salt = MaterialSpec(name="Abstract Salt",
                        template=tmpl["Formulaic Material"],
                        process=ProcessSpec(name='Buying Salt, in General',
                                            template=tmpl["Procurement"],
                                            tags=['purchase::dry-goods'],
                                            notes='Purchasing salt'),
                        tags=[],
                        notes='Plain old NaCl',
                        properties=[
                            PropertyAndConditions(
                                Property(name='Formula',
                                         value=EmpiricalFormula("NaCl")))
                        ])
    IngredientSpec(
        **ingredient_kwargs(salt),
        labels=['dry', 'seasoning'],
        process=drymix.process,
        volume_fraction=NominalReal(nominal=0.0034, units='')  # 1/2 teaspoon
    )

    sugar = MaterialSpec(
        name="Abstract Sugar",
        template=tmpl["Formulaic Material"],
        process=ProcessSpec(name='Buying Sugar, in General',
                            template=tmpl["Procurement"],
                            tags=['purchase::dry-goods'],
                            notes='Purchasing all purpose flour'),
        tags=[],
        notes='Sugar',
        properties=[
            PropertyAndConditions(
                Property(name="Formula", value=EmpiricalFormula("C12H22O11"))),
            PropertyAndConditions(
                Property(name='SMILES',
                         value=Smiles(
                             "C(C1C(C(C(C(O1)OC2(C(C(C(O2)CO)O)O)CO)O)O)O)O"),
                         template=tmpl["Molecular Structure"]))
        ])
    IngredientSpec(**ingredient_kwargs(sugar),
                   labels=['wet', 'sweetener'],
                   process=wetmix.process,
                   absolute_quantity=NominalReal(nominal=2, units='cups'))

    butter = MaterialSpec(
        name="Abstract Butter",
        template=tmpl["Generic Material"],
        process=ProcessSpec(name='Buying Butter, in General',
                            template=tmpl["Procurement"],
                            tags=['purchase::produce'],
                            notes='Purchasing butter'),
        tags=[],
        notes='Shortening for making rich, buttery baked goods')
    IngredientSpec(**ingredient_kwargs(butter),
                   labels=['wet', 'shortening'],
                   process=wetmix.process,
                   absolute_quantity=NominalReal(nominal=1, units='cups'))
    IngredientSpec(
        **ingredient_kwargs(butter),
        labels=['shortening'],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.1434,
                                  units='')  # 1/2 c @ 0.911 g/cc
    )

    eggs = MaterialSpec(name="Abstract Eggs",
                        template=tmpl["Generic Material"],
                        process=ProcessSpec(name='Buying Eggs, in General',
                                            template=tmpl["Procurement"],
                                            tags=['purchase::produce'],
                                            notes='Purchasing eggs'),
                        tags=[],
                        notes='')
    IngredientSpec(**ingredient_kwargs(eggs),
                   labels=['wet'],
                   absolute_quantity=NominalReal(nominal=4, units=''))

    vanilla = MaterialSpec(
        name="Abstract Vanilla",
        template=tmpl["Generic Material"],
        process=ProcessSpec(name='Buying Vanilla, in General',
                            template=tmpl["Procurement"],
                            tags=['purchase::dry-goods'],
                            notes='Purchasing vanilla'),
        tags=[],
        notes=
        'Vanilla Extract is mostly alcohol but the most important component '
        'is vanillin (see attached structure)',
        properties=[
            PropertyAndConditions(
                Property(
                    name='Component Structure',
                    value=InChI(
                        "InChI=1S/C8H8O3/c1-11-8-4-6(5-9)2-3-7(8)10/h2-5,10H,1H3"
                    ),
                    template=tmpl["Molecular Structure"]))
        ])
    IngredientSpec(**ingredient_kwargs(vanilla),
                   labels=['wet', 'flavoring'],
                   process=wetmix.process,
                   absolute_quantity=NominalReal(nominal=2, units='teaspoons'))
    IngredientSpec(
        **ingredient_kwargs(vanilla),
        labels=['flavoring'],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.0231,
                                  units='')  # 2 tsp @ 0.879 g/cc
    )

    milk = MaterialSpec(name="Abstract Milk",
                        template=tmpl["Generic Material"],
                        process=ProcessSpec(name='Buying Milk, in General',
                                            template=tmpl["Procurement"],
                                            tags=['purchase::produce'],
                                            notes='Purchasing milk'),
                        tags=[],
                        notes='')
    IngredientSpec(**ingredient_kwargs(milk),
                   labels=['wet'],
                   process=batter.process,
                   absolute_quantity=NominalReal(nominal=1, units='cup'))
    IngredientSpec(
        **ingredient_kwargs(milk),
        labels=[],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.0816,
                                  units='')  # 1/4 c @ 1.037 g/cc
    )

    chocolate = MaterialSpec(name="Abstract Chocolate",
                             template=tmpl["Generic Material"],
                             process=ProcessSpec(
                                 name='Buying Chocolate, in General',
                                 template=tmpl["Procurement"],
                                 tags=['purchase::dry-goods'],
                                 notes='Purchasing chocolate'),
                             tags=[],
                             notes='')
    IngredientSpec(
        **ingredient_kwargs(chocolate),
        labels=['flavoring'],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.1132, units='')  # 3 oz.
    )

    powder_sugar = MaterialSpec(
        name="Abstract Powdered Sugar",
        template=tmpl["Generic Material"],
        process=ProcessSpec(name='Buying Powdered Sugar, in General',
                            template=tmpl["Procurement"],
                            tags=['purchase::dry-goods'],
                            notes='Purchasing powdered sugar'),
        tags=[],
        notes='Granulated sugar mixed with corn starch')
    IngredientSpec(
        **ingredient_kwargs(powder_sugar),
        labels=['flavoring'],
        process=frosting.process,
        mass_fraction=NominalReal(nominal=0.6387,
                                  units='')  # 4 c @ 30 g/ 0.25 cups
    )

    # Crawl tree and annotate with uids; only add ids if there's nothing there
    recursive_foreach(
        cake, lambda obj: obj.uids or obj.add_uid(DEMO_SCOPE, obj.name))

    return cake