Migrate combustion and EPW-reader from Hive.Core to Hive.IO #692

maxenceryan · 2021-12-16T10:29:36Z

Issues

Closes #686

Description

Migrate the epw-reader from ghpy to Hive.IO

EPW-reader now reads the EPW class given by the Hive.Environment instead of re-parsing the EPW file
ins and outs are the same except
- formatting of City, Country is slightly different
only main template and a new environment GH test file were changed

TODO:

@christophwaibel in many gh example files, a simple path is given to the python EPW reader, which now no longer works. Should I change all the testfiles to reflect the proposed set up (epw-path -> environment -> hive inputs -> env distributor -> epw reader instead of just epw-path -> epw-reader)? Or is it better to keep an option for simply giving the path? We could also move the parsing to the epw-reader instead of the environment component.

Checklist

Remove debugging artifacts (if needed)
Rebuild the Setup_Hive.exe
Update Hive Wiki (if needed)
Update InformationalVersion attribute in Hive.IO/Properties/AssemblyInfo.cs (if it's a new release)
Update most important Grasshopper template(s); as of now /GrasshopperExamples/LectureExercises/EaCS3_E04_Hive_Template.gh

…eader, include icons in resources, create epw distributor, update env distributor

christophwaibel · 2021-12-16T10:48:15Z

hey @maxenceryan , I suggest to keep an option for a simple workflow without needing to go through the whole environment->envDistributor pipeline. Yes, I think it makes sense to move the parsing to the EpwReader component. Please also note our naming convention of using a Prefix Gh(...) for all grasshopper components

christophwaibel · 2021-12-16T10:51:19Z

src/Hive.Core/epw_reader/EpwReader.cs

+            DA.SetData(0, Latitude);
+            DA.SetData(1, Longitude);
+            DA.SetData(2, City, Country);
+            DA.SetData(3, GHI);
+            DA.SetData(4, DNI);
+            DA.SetData(5, DHI);
+            DA.SetData(6, DryBulb);
+            DA.SetData(7, DewPoint);
+            DA.SetData(8, RH);
+            DA.SetData(9, GHIMonthly);
+            DA.SetData(10, DryBulbMonthly);
+            DA.SetData(11, RHMonthly);
+            DA.SetData(12, AmbientTemperatureCarrier);
+            DA.SetData(13, Timezone);


so this is computationally very slow, because grasshopper turns everything into GH_Numbers. Could you only output an epw-object by default, and these separate outputs only get written if a boolean is set to true?

this is actually the wrong cs file, i forgot to delete it... you'll see the other one in Hive.IO. but your comment still applies. So would the idea be that this distributor only functions when the bool input is true? Should I pass the EPW object to other components, such as sia380 and solar stuff instead of the gh numbers?

That would be excellent! As much as possible, we should avoid dumping out gh numbers. It exceeds a bit the original scope of this issue, but if you can already implement that (pasing only the epw object instead of separate lists of gh numbers), that would be marvelous

And , yes , only dump out those lists if a bool is set to true. From a novel grasshopper user perspective , that would be useful to access information from an epw

christophwaibel · 2021-12-16T10:52:50Z

src/Hive.Core/epw_reader/EpwReader.cs

+            pManager.AddTextParameter("Path", "Path", "Path of the epw file", GH_ParamAccess.item);
+        }


maybe add `pManager.AddBooleanParameter("write GH_Numbers", (...), "additionally to the epw-object, weather file data is output explicitly separately", ...)

maxenceryan · 2021-12-16T21:59:48Z

an issue with having parsing only in the EPW distributor is that the GhEnvironment component actually needs EPW already parsed in order to set a couple of the default energy potentials, which are passed along at the EnvDistributor.

l69-71 in Environment.SetDefaultEnergyPotentials()

            this.EnergyPotentials[6] = new Air(this.Horizon, null, null, null, this.EpwData.DryBulbTemperature);
            this.EnergyPotentials[6].Name = "DryBulbTemperature";
            this.EnergyPotentials[7] = new Radiation(this.Horizon, this.EpwData.GHI);

We couuuld just say either plug in an Hive.IO.EPW class object OR the filepath into the EPW Distributor component, with priority given to the EPW object if not null.

…rsing to epw dist

christophwaibel · 2021-12-17T11:37:34Z

an issue with having parsing only in the EPW distributor is that the GhEnvironment component actually needs EPW already parsed in order to set a couple of the default energy potentials, which are passed along at the EnvDistributor.

l69-71 in Environment.SetDefaultEnergyPotentials()
            this.EnergyPotentials[6] = new Air(this.Horizon, null, null, null, this.EpwData.DryBulbTemperature);
            this.EnergyPotentials[6].Name = "DryBulbTemperature";
            this.EnergyPotentials[7] = new Radiation(this.Horizon, this.EpwData.GHI);
We couuuld just say either plug in an Hive.IO.EPW class object OR the filepath into the EPW Distributor component, with priority given to the EPW object if not null.

right. then let the GhEnvironment already parse the epw and, as you said, the GhDistEpw either reads in a path (and parses the epw itself), or reads in an epw object and doesn't need to parse itself anymore.

the boolean, I might have explained it incorrectly. So the parsing should happen either way, but just dumping out the DataLists should be optional

@maxenceryan

@maxenceryan this is what I meant. does it make sense?

maxenceryan · 2021-12-17T14:51:37Z

sounds good, your comment and commit make sense to me. Hopefully I can wrap this up by monday

maxenceryan · 2021-12-20T09:42:23Z

@christophwaibel ok so I finished up the EPW reader stuff as per the comments. You can see how it compares to the python solution in GrasshopperExamples\Testing\Hive_Environment_Test.gh. The assert code for comparing C# and python component is a tad messy... but it would throw an error if they didnt match.

You can also look in GrasshopperExamples\Testing\Hive_Distributor_Test.gh to see how it would look like from now on.

A few things;

I still need to update the EPW component in the other GH files, so a commit will be incoming.
Once you are done with your review, it'd be nice if you could:
- comment out the python epw-reader building in build.cmd
- delete the python component and assert madness in GrasshopperExamples\Testing\Hive_Environment_Test.gh.
Finally, i had already migrated the simple combustion components, so they are still there. As you said, we don't need them anymore, so should I for sure delete them or save them somewhere?

Thanks!

…nd user perspective

christophwaibel · 2021-12-21T11:55:26Z

A few things;

I still need to update the EPW component in the other GH files, so a commit will be incoming.

should I wait for another commit? otherwise, you can merge this PR, @maxenceryan

comment out the python epw-reader building in build.cmd

can't do yet, because there is a ghpython component in the main template that relies on following lines from epw_reader.py:

clr.AddReferenceToFileAndPath(os.path.join(path, "Libraries\Hive", "Hive.IO.gha"))
import Hive.IO.EnergySystems as ensys

I'll make a separate issue about it.

delete the python component and assert madness in GrasshopperExamples\Testing\Hive_Environment_Test.gh.

done

Finally, i had already migrated the simple combustion components, so they are still there. As you said, we don't need them anymore, so should I for sure delete them or save them somewhere?

as discussed before in the sprint: let's keep them for now

christophwaibel · 2021-12-16T10:53:39Z

src/Hive.Core/epw_reader/EpwReader.cs

+        {
+            pManager.AddNumberParameter("Latitude", "Latitude", "Latitude in deg", GH_ParamAccess.item);
+            pManager.AddNumberParameter("Longitude", "Longitude", "Longitude in deg", GH_ParamAccess.item);


first output: pManager.AddCustom...?Parameter("EPW Hive object", ...)?

ah... I mean AddGenericObjectParameter

christophwaibel · 2021-12-16T10:57:09Z

src/Hive.Core/epw_reader/EpwReader.cs

+{
+    public class EpwReader : GH_Component
+    {


GhEpwReader

christophwaibel · 2021-12-16T10:57:52Z

src/Hive.Core/epw_reader/EpwReader.cs

+
+            // TODO
+


we could just call Environment/epw.cs here and leave the parsing script where it is

christophwaibel · 2021-12-16T16:16:51Z

src/Hive.Core/epw_reader/EpwReader.cs

+            DA.SetData(0, Latitude);
+            DA.SetData(1, Longitude);
+            DA.SetData(2, City, Country);
+            DA.SetData(3, GHI);
+            DA.SetData(4, DNI);
+            DA.SetData(5, DHI);
+            DA.SetData(6, DryBulb);
+            DA.SetData(7, DewPoint);
+            DA.SetData(8, RH);
+            DA.SetData(9, GHIMonthly);
+            DA.SetData(10, DryBulbMonthly);
+            DA.SetData(11, RHMonthly);
+            DA.SetData(12, AmbientTemperatureCarrier);
+            DA.SetData(13, Timezone);


That would be excellent! As much as possible, we should avoid dumping out gh numbers. It exceeds a bit the original scope of this issue, but if you can already implement that (pasing only the epw object instead of separate lists of gh numbers), that would be marvelous

christophwaibel · 2021-12-16T16:18:16Z

src/Hive.Core/epw_reader/EpwReader.cs

+            DA.SetData(0, Latitude);
+            DA.SetData(1, Longitude);
+            DA.SetData(2, City, Country);
+            DA.SetData(3, GHI);
+            DA.SetData(4, DNI);
+            DA.SetData(5, DHI);
+            DA.SetData(6, DryBulb);
+            DA.SetData(7, DewPoint);
+            DA.SetData(8, RH);
+            DA.SetData(9, GHIMonthly);
+            DA.SetData(10, DryBulbMonthly);
+            DA.SetData(11, RHMonthly);
+            DA.SetData(12, AmbientTemperatureCarrier);
+            DA.SetData(13, Timezone);


And , yes , only dump out those lists if a bool is set to true. From a novel grasshopper user perspective , that would be useful to access information from an epw

ChrisZenhub · 2021-12-21T12:34:24Z

@maxenceryan when merging with the current master, you can keep the EaCS3_E04_Hive_Template.gh from this PR and overwrite master. But @mmatache25 did some changes to the EnergySystems Hizard, so keep an eye on what you merge from Hive.IO.csproj.

Also, I'm not sure if this PR already merged the updated PV / BIPV catalogues

maxenceryan · 2021-12-22T15:33:32Z

ok so merging now. Last thing I did:

removed Hive.Core.combustion from build.cmd as it is now in Hive.IO. NSI script also does not install it and removes the ghpy if it was there from a previous version
kept epw-reader in build.cmd and as part of installer for now
fixed the compiling script for BIPV, it is now compiled to JSON with PV and ST (although will not be accessible for the user until adding BIPV as separate technology to the Energy Systems Hizard #677)

Max Ryan added 2 commits December 15, 2021 22:17

Create migration script, migrate simple energy systems, migrate epw r…

e84ac28

…eader, include icons in resources, create epw distributor, update env distributor

Update examples

d05b0eb

maxenceryan self-assigned this Dec 16, 2021

christophwaibel reviewed Dec 16, 2021

View reviewed changes

maxenceryan changed the title ~~686 migrate combustion~~ Migrate EPW-reader from Hive.Core to Hive.IO Dec 16, 2021

Merge branch 'master' into 686-migrate-combustion

08e8cb7

Cleanup some resources, add bool for running epw distributor, move pa…

56e4f44

…rsing to epw dist

christophwaibel mentioned this pull request Dec 17, 2021

Migrate Hive.Core.sia380 #688

Closed

updated GhDistEpw

40925ca

@maxenceryan this is what I meant. does it make sense?

Fixed the IO for EPW distributor, created test files to show it works.

e90bd4a

maxenceryan marked this pull request as ready for review December 20, 2021 09:28

Max Ryan added 3 commits December 20, 2021 10:29

Merge branch 'master' into 686-migrate-combustion

ceec8fa

Fix resourcedesigner

215ada8

Rename simple combustion systems classes

36fb5c3

Max Ryan and others added 3 commits December 20, 2021 10:43

Fix renaming and clean up test files

a94677e

Update gh testfiles

2731d7b

some minor refactoring to be more consistent with Hive architecture a…

f9d2bbb

…nd user perspective

christophwaibel approved these changes Dec 21, 2021

View reviewed changes

christophwaibel mentioned this pull request Dec 21, 2021

replace electricityMerger ghpython component in Core #701

Closed

Max Ryan added 3 commits December 21, 2021 20:35

Merge branch 'master' into 686-migrate-combustion

e867d48

Rebuild, update gh test files.

8fce793

Fix build script to remove Core.combustion

9005a34

Add BIPV to surface tech modules compiling script.

a9e20ed

maxenceryan changed the title ~~Migrate EPW-reader from Hive.Core to Hive.IO~~ Migrate combustion and EPW-reader from Hive.Core to Hive.IO Dec 22, 2021

maxenceryan merged commit ce83574 into master Dec 22, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate combustion and EPW-reader from Hive.Core to Hive.IO #692

Migrate combustion and EPW-reader from Hive.Core to Hive.IO #692

maxenceryan commented Dec 16, 2021 •

edited by christophwaibel

Loading

christophwaibel commented Dec 16, 2021

christophwaibel Dec 16, 2021

maxenceryan Dec 16, 2021

christophwaibel Dec 16, 2021

christophwaibel Dec 16, 2021

christophwaibel Dec 16, 2021

maxenceryan commented Dec 16, 2021

christophwaibel commented Dec 17, 2021

maxenceryan commented Dec 17, 2021

maxenceryan commented Dec 20, 2021

christophwaibel commented Dec 21, 2021 •

edited

Loading

christophwaibel Dec 16, 2021

christophwaibel Dec 16, 2021

christophwaibel Dec 16, 2021

christophwaibel Dec 16, 2021

christophwaibel Dec 16, 2021

christophwaibel Dec 16, 2021

ChrisZenhub commented Dec 21, 2021 •

edited

Loading

maxenceryan commented Dec 22, 2021

		pManager.AddTextParameter("Path", "Path", "Path of the epw file", GH_ParamAccess.item);
		}

Migrate combustion and EPW-reader from Hive.Core to Hive.IO #692

Migrate combustion and EPW-reader from Hive.Core to Hive.IO #692

Conversation

maxenceryan commented Dec 16, 2021 • edited by christophwaibel Loading

Issues

Description

Checklist

christophwaibel commented Dec 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxenceryan commented Dec 16, 2021

christophwaibel commented Dec 17, 2021

maxenceryan commented Dec 17, 2021

maxenceryan commented Dec 20, 2021

christophwaibel commented Dec 21, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChrisZenhub commented Dec 21, 2021 • edited Loading

maxenceryan commented Dec 22, 2021

maxenceryan commented Dec 16, 2021 •

edited by christophwaibel

Loading

christophwaibel commented Dec 21, 2021 •

edited

Loading

ChrisZenhub commented Dec 21, 2021 •

edited

Loading