<%= taxonomy %> doesn't work in README.md.erb

[DavidGoldwasser]

https://github.com/NREL/OpenStudio/blob/6aed934ea899f50ee017347bf4333687f5af15ca/openstudiocore/src/utilities/bcl/templates/common/README.md.erb#L17

This isn't a big deal, but if it is an easy fix and if we have to make a new installer anyway, it would be nice to fix. This will the readme.md on the all the updated measures on BCL.

Note: this doesn't error out the process, it just ends up with a blank space on the Readme.md under taxonomy.

[macumber]

Looks like the issue here is that I added support for putting taxonomy in the measure.rb which will update it in the XML. Taxonomy in measure.rb will end up in the readme.md but not if it is only in the xml.

def taxonomy
return 'Envelope.form'
end

[DavidGoldwasser]

Ok, so more of a measure update issue than core C++. That makes sense. I can close this issue unless you see reason to keep it open. For measures, I think would probably just add the def to measure.rb as measure are worked on. I don't think we have the time or an automated way to batch change them.

[macumber]

Related to #3159

[DavidGoldwasser]

I'm going to re-open this as it is something I want to show on all measure.rb files to identify where the users will find these measures on BCL.

[jmarrec]

I am not following what the action item(s) is (are) @DavidGoldwasser? Could you explain please?

If I follow correctly:

• Taxonomy is originally more meant to be inside the measure.xml as several <tag> (inside <tags>) https://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/#measure-metadata-file-measurexml
  • https://github.com/NREL/OpenStudio/blob/3d8ee1fc5a9db6654d2c451be5bafeadda6250be/src/utilities/bcl/BCLMeasure.hpp#L158
• But it was implemented as a method def taxonomy inside the measure.rb, while the C++ implies a single tag: while the C++ MeasureInfo implies a single tag: https://github.com/NREL/OpenStudio/blob/3d8ee1fc5a9db6654d2c451be5bafeadda6250be/src/measure/OSMeasureInfoGetter.hpp#L82-L83
• Shouldn't we accept a LIST inside of a single string for taxonomy?

So how do we resolve this?

Could it be this?

• Update the measure template to have a taxonomy method. Probably make it accept a list too.

  # A single string, or a list of BCL tags (shown here) https://bcl.nrel.gov/api/taxonomy/measure
  def taxonomy
    return ['Envelope.form', 'HVAC.HVAC Controls']
  end

• (On OSApp side, the user-selected taxonomy should end up in the template...)
• Upon openstudio measure -u ., this should populate the tags section of the measure.xml

  <tags>
    <tag>Envelope.form</tag>
    <tag>HVAC.HVAC Controls</tag>
  </tags>

• Modify the default README.md.erb if it needs to handles a LIST inside of a raw string.

<% if taxonomy.size > 0 %>
## Taxonomy
<%= taxonomy.each do |tag| %>
* <%= argument[:name] %>
<% end %>

[jmarrec]

I'm not sure why the XML would allow several tags but setTaxonomyTag is single-use only.

https://github.com/NREL/OpenStudio/blob/3d8ee1fc5a9db6654d2c451be5bafeadda6250be/src/utilities/bcl/BCLMeasure.hpp#L190-L195