cse-sim / cse

California Simulation Engine
BSD 3-Clause "New" or "Revised" License
15 stars 5 forks source link

Improvements to automated documentation #200

Open nealkruis opened 2 years ago

nealkruis commented 2 years ago
sisray921 commented 1 year ago

Adding a comment to this issue: Just a polite request that you endeavor to include units where feasible in the documentation. For example, I'm doing a quick study of DHW recirculation and I'm inputting wlLossMakeupPwr and I'm not completely sure which units are expected. (I'm guessing that generally it's BTUH...). Not urgent, but a 'nice to have' as you're cleaning up documentation in the future.

chipbarnaby commented 1 year ago

I see the units documented under Units in the table below the description. W, not Btuh.

If that is missing from the documentation you are using, let me know the source of your copy and we'll try to figure out why it is not up to date.

Any other suggestions are welcome. The documentation can definitely use some improvement.

Chip

wlLossMakeupPwr=float

Specifies electrical power available to make up losses from DHWLOOPSEGs <#dhwloopseg> (loss from DHWLOOPBRANCHs <#dhwloopbranch> is not included). Separate loss makeup is typically used in multi-unit HPWH systems to avoid inefficiencies associated with high condenser temperatures. Loss-makeup energy is calculated hourly and is the smaller of loop losses and wlLossMakeupPwr. The resulting electricity use (including the effect of wlLossMakeupEff) is accumulated to the METER <#meter> specified by wlElecMtr (end use dhwMFL). No other effect, such as heat gain to surroundings, is modeled. *UnitsLegal RangeDefaultRequiredVariability W x* ≥ 0 0 No hourly

On Thu, Mar 9, 2023 at 1:13 PM Luke Morton @.***> wrote:

Adding a comment to this issue: Just a polite request that you endeavor to include units where feasible in the documentation. For example, I'm doing a quick study of DHW recirculation and I'm inputting wlLossMakeupPwr and I'm not completely sure which units are expected. (I'm guessing that generally it's BTUH...). Not urgent, but a 'nice to have' as you're cleaning up documentation in the future.

— Reply to this email directly, view it on GitHub https://github.com/cse-sim/cse/issues/200#issuecomment-1462545365, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACWGW7CUWRXLT4J3WYKHLXDW3IMTJANCNFSM5R64RMTA . You are receiving this because you were assigned.Message ID: @.***>

sisray921 commented 1 year ago

Thanks Chip! I see it now! (I'm wondering if I just missed it before... totally possible...) Yes-- will let you know if other units are missing. Thanks for the response!

On Thu, Mar 9, 2023 at 11:12 AM Chip Barnaby @.***> wrote:

I see the units documented under Units in the table below the description. W, not Btuh.

If that is missing from the documentation you are using, let me know the source of your copy and we'll try to figure out why it is not up to date.

Any other suggestions are welcome. The documentation can definitely use some improvement.

Chip

wlLossMakeupPwr=float

Specifies electrical power available to make up losses from DHWLOOPSEGs <#dhwloopseg> (loss from DHWLOOPBRANCHs <#dhwloopbranch> is not included). Separate loss makeup is typically used in multi-unit HPWH systems to avoid inefficiencies associated with high condenser temperatures. Loss-makeup energy is calculated hourly and is the smaller of loop losses and wlLossMakeupPwr. The resulting electricity use (including the effect of wlLossMakeupEff) is accumulated to the METER <#meter> specified by wlElecMtr (end use dhwMFL). No other effect, such as heat gain to surroundings, is modeled. *UnitsLegal RangeDefaultRequiredVariability W x* ≥ 0 0 No hourly

On Thu, Mar 9, 2023 at 1:13 PM Luke Morton @.***> wrote:

Adding a comment to this issue: Just a polite request that you endeavor to include units where feasible in the documentation. For example, I'm doing a quick study of DHW recirculation and I'm inputting wlLossMakeupPwr and I'm not completely sure which units are expected. (I'm guessing that generally it's BTUH...). Not urgent, but a 'nice to have' as you're cleaning up documentation in the future.

— Reply to this email directly, view it on GitHub https://github.com/cse-sim/cse/issues/200#issuecomment-1462545365, or unsubscribe < https://github.com/notifications/unsubscribe-auth/ACWGW7CUWRXLT4J3WYKHLXDW3IMTJANCNFSM5R64RMTA

. You are receiving this because you were assigned.Message ID: @.***>

— Reply to this email directly, view it on GitHub https://github.com/cse-sim/cse/issues/200#issuecomment-1462629814, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASQOKSGZC5O3N6TLQEV3KQDW3ITSJANCNFSM5R64RMTA . You are receiving this because you commented.Message ID: @.***>