Changes to AI profile to accommodate expressing energyConsumption

[rgopikrishnan91]

@kestewart @goneall This is part 4 of the PR. Please review it. With this the changes we discussed for Energy consumption should be done.

[goneall]

Couple changes to be consistent with the naming conventions

[rgopikrishnan91]

Signed-off-by: Gopi Krishnan Rajbahadur gopikrishnanrajbahadur@gmail.com

[rgopikrishnan91]

@bact @goneall @kestewart Please take a look at this PR. I have made the requested changes and combined all the changes here. Please let me know your thoughts.

[goneall]

A few file renamings requested. Note - the renamed files will trigger a more robust CI checking.

[kestewart]

@rgopikrishnan91 - can you apply the file extension changes that Gary flagged, and the clarification of kWh from Art, and then I'lll apply this. Merged patch looks good - thanks for doing this.

[rgopikrishnan91]

@kestewart @goneall @bact I have made the request changes. Could you guys please review it and merge it?

[rgopikrishnan91]

Not sure what the parser is complaining about..I haven't changed anything drastic...

[goneall]

Thanks @rgopikrishnan91

It looks like the validation is failing:

0s
Run python /home/runner/work/_temp/spec-parser/main.py -n model
Traceback (most recent call last):
  File "/home/runner/work/_temp/spec-parser/main.py", line [1](https://github.com/spdx/spdx-3-model/actions/runs/8584156125/job/23524144900?pr=697#step:5:1)1, in <module>
    m = Model(cfg.input_dir)
        ^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/_temp/spec-parser/spec_parser/model.py", line 28, in __init__
    self.load(dir)
  File "/home/runner/work/_temp/spec-parser/spec_parser/model.py", line 96, in load
    proptype = self.properties[pname].metadata["Range"]
               ~~~~~~~~~~~~~~~^^^^^^^
KeyError: '/AI/value'

I haven't had time to research, but there is probably a reference to a class or property with the name value without a corresponding definition.

[zvr]

Yes, @goneall and @rgopikrishnan91 :
this PR introduces EnergyConsumptionDescription which uses properties value and unit, but there are no definitions of these properties.

[goneall]

Yes, @goneall and @rgopikrishnan91 : this PR introduces EnergyConsumptionDescription which uses properties value and unit, but there are no definitions of these properties.

Thanks @zvr - @rgopikrishnan91 - you'll need to add property files for value and unit to resolve.

[bact]

Thank you @rgopikrishnan91 and @zvr.

If so, since:

• the names value and unit can be very generic even for within the AI domain/namespace; and
• value has already been used in the Core for a property for a generic key-value pair.

could we also rename them to energyQuantity and energyUnit?

Also shorten EnergyConsumptionDescriptionUnitType to EnergyUnitType as the type can be used for energy unit of any purpose.

They may all look like this:

---

(1) [MODIFIED] model/AI/Classes/EnergyConsumptionDescription.md

SPDX-License-Identifier: Community-Spec-1.0

# EnergyConsumptionDescription

## Summary

The class that helps note down the quantity of energy consumption and the unit
used for measurement.

## Description

This class is designed to store energy consumption data, including the quantity
and the unit of measurement.

The energyQuantity property stores the amount of energy consumed,
and the energyUnit property stores the unit used for measurement.

## Metadata

- name: EnergyConsumptionDescription
- Instantiability: Concrete

## Properties

- energyQuantity
  - type: xsd:decimal
  - minCount: 1
  - maxCount: 1
- energyUnit
  - type: EnergyUnitType
  - minCount: 1
  - maxCount: 1

---

(2) [NEW] model/AI/Properties/energyQuantity.md

SPDX-License-Identifier: Community-Spec-1.0

# energyQuantity

## Summary

Represents the energy quantity.

## Description

Provides the quantity information of the energy.

## Metadata

- name: energyQuantity
- Nature: DataProperty
- Range: xsd:decimal

---

(3) [NEW] model/AI/Properties/energyUnit.md

SPDX-License-Identifier: Community-Spec-1.0

# energyUnit

## Summary

Specifies the unit in which energy is measured.

## Description

Provides the unit information of the energy.

## Metadata

- name: energyUnit
- Nature: ObjectProperty
- Range: EnergyUnitType

---

(4) [MODIFIED] model/AI/Vocabularies/EnergyUnitType.md

(Was: model/AI/Vocabularies/EnergyConsumptionDescriptionUnitType.md)

SPDX-License-Identifier: Community-Spec-1.0

# EnergyUnitType

## Summary

Specifies the unit of energy consumption.

## Description

List the different acceptable units for measuring energy consumption.

If the unit in which the energy consumption has been recorded
is not listed here, please select "other".

## Metadata

- name: EnergyUnitType

## Entries

- kilowattHour: Kilowatt-hour.
- megajoule: Megajoule.
- other: Any other units of energy measurement. 

---

Thanks Gopi again for all the efforts.

[kestewart]

@rgopikrishnan91 - can you apply the fixes that Art, Alexios & Gary suggest?

[kestewart]

See comments from Art, Alexios & Gary

[rgopikrishnan91]

@kestewart @goneall @bact @zvr Hi thanks for all the comments and feedback. I have made the required changes and the parser seems to be happy now. Please let me know if these changes look good.

[kestewart]

Changes look good to me - @bact, @zvr - can you take a look?

[bact]

Looks good to me as well. Thank you everyone.