Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review descriptions in all parameters #42

Open
thclark opened this issue Sep 26, 2023 · 0 comments
Open

Review descriptions in all parameters #42

thclark opened this issue Sep 26, 2023 · 0 comments
Assignees

Comments

@thclark
Copy link
Contributor

thclark commented Sep 26, 2023

Summary

We need to improve/align the description elements throughout. Additional precision can avoid problems downstream.

What's particularly useful is the ability to refer to terminology in other IEC standards.

Example comment from emil:

@thclark @kersting I skimmed the "lump" and saw one thing I'd like to change, see following code
"model_name": {
"type": "string",
"title": "Model name",
"description": "Name of the turbine model (according to the manufacturer)",

Rather than "according to the manufacturer" I recommend we use "as stated on the certificate, TC, DECS, other"
Where TC = Type Certificate
DECS = Design Evaluation Conformity Statement
other could include Statement of Compliance etc.
I am pressing this point because OEMs, in my experience, sometimes use a shorthand or are inconsistent. Within my organization they like to label power to the first decimal point etc. I press everyone in my loop to use the name on the certification document. I hope we can do the same here.
Originally posted by @Dash16PM in #39 (comment)

To-Do List

**For each term, we need to ensure that:

  • the term is in the IEC portal document

  • including examples either

  • the description is correct and consistent between portal and schema.**

  • document

    • metadata
  • turbine

    • manufacturer_name
    • manufacturer_display_name
    • model_name
    • model_description
    • platform_name
    • platform_description
    • rotor_diameter
    • number_of_blades
    • drive_type
    • regulation_type
    • rated_power
    • cut_in_rpm
    • rated_rpm
    • available_hub_heights
    • grid_frequencies
  • design_bases

    • label
    • name
    • certification
      • standard
      • standard_edition
      • certificate_reference
    • design_class
      • oneOf
        • THIS, OR
          class_label
        • THIS
          • class_label
          • annual_average_wind_speed
          • annual_average_air_density
          • reference_wind_speed
          • weibull_shape_factor
          • vertical_shear_exponent
          • inflow_angle
          • design_lifetime
    • turbulence
      • anyOf
        • THIS, OR
          • category
        • THIS, OR
          • category
          • reference_turbulence_intensity
          • slope
        • THIS, OR
          • category
          • wind_speed
          • normal_turbulence_intensity
          • extreme_turbulence_intensity
        • THIS
          • category
          • wind_speed
          • normal_turbulence_intensity
          • normal_hours_per_lifetime
          • extreme_turbulence_intensity
    • standard_climate
      • operating_temperature_range
      • survival_temperature_range
    • cold_climate
      • operating_temperature_range
      • survival_temperature_range
    • hot_climate:
      • operating_temperature_range
      • survival_temperature_range
  • power_curves

    • default_mode
    • modes
      • label
      • name
      • design_bases
      • description
      • cuts
        • kind
        • wind_speed
        • period
      • parameters
        • label

        • dimension

        • values

        • cp_is_coefficient NOT YET - NEEDS REFACTORING

        • ct_is_coefficient NOT YET - NEEDS REFACTORING

        • cp NOT YET - NEEDS REFACTORING

        • ct NOT YET - NEEDS REFACTORING

        • acoustic_emissions

          • oneOf
            • THIS, OR
              • margin
              • weighting
              • wind_speed
              • frequency
              • sound_pressure_level
            • THIS, OR
              • margin
              • weighting
              • wind_speed
              • frequency
              • sound_pressure_level
            • THIS
              • margin
              • weighting
              • wind_speed
              • sound_pressure_level
        • overrides

          • rated_power
          • cut_in_rpm
          • rated_rpm
          • available_hub_heights
@thclark thclark changed the title Clarify model_name parameter Review descriptions in all parameters Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

No branches or pull requests

2 participants