CSharp - Update for conan V2 and build for 3.8.0 (+ add arm64) #5211

jmarrec · 2024-05-21T21:16:01Z

Pull request overview

Pull Request Author

Model API Changes / Additions
Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
Model API methods are tested (in src/model/test)
EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
All new and existing tests passes
If methods have been deprecated, update rest of code to use the new methods

Labels:

If change to an IDD file, add the label IDDChange
If breaking existing API, add the label APIChange
If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

Perform a Code Review on GitHub
Code Style, strip trailing whitespace, etc.
All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
Labeling is ok
If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
If feature, test running new feature, try creative ways to break it
CI status: all green or justified

…config Ubuntu: got “PCRE regex matching is not available in this SWIG build” ?

… PRCE

jmarrec · 2024-05-21T22:38:53Z

Gonna close this PR temporarily so I don't get the cppcheck/clangformat running for no reason on it

…lt, sometimes conan-release?

…conan-release

…instead

…uild on win32

jmarrec · 2024-05-22T11:57:53Z

Alright 3.8.0 packages, including the new osx-arm64 are available on this run: https://github.com/NREL/OpenStudio/actions/runs/9189117111/job/25275666930

@kbenne I hosted the windows (that contains both win32 and x64) on https://www.nuget.org/packages/OpenStudio/3.8.0

@MingboPeng FYI if you want to upload them to your nuget packages per platform.

jmarrec · 2024-05-22T12:11:29Z

conan.lock

@@ -5,7 +5,7 @@
        "websocketpp/0.8.2#842a0419153a8aa52f3ea3a1da557d38%1695972005.713",
        "tinygltf/2.5.0#65c28d0a4c3cbd4ef92b08b59df769da%1701621757.442",
        "termcap/1.3.1#1986f84bf21dd07ea774b027a3201fcb%1678542508.75",
-        "swig/4.1.1#8f418438101ef7712d52a9fe739d32f9%1707838298.077707",
+        "swig/4.1.1#2bb5c79321cbb05bcab525c690d9bf74%1716336914.081294",


Tweaked and built from jmarrec/conan-center-index@52e12ba

jmarrec · 2024-05-22T12:12:36Z

conanfile.py

+        "with_ruby": True,
+        "with_python": True,
+        "with_csharp": False,


New options to allow disabling ruby (won't build on win32), and tweak the cmake vars as well.

jmarrec · 2024-05-22T12:13:09Z

src/measure/Measure.i

+  // Ignore Json::Value return type (toJSON / fromJSON / valueAsJSON are globally ignored already)
+  %ignore openstudio::measure::OSArgument::defaultValueAsJSON;
+  %ignore openstudio::measure::OSArgument::domainAsJSON;
+  %ignore openstudio::measure::OSRunner::getArgumentValues;
+  %ignore openstudio::measure::OSRunner::getPastStepValuesForMeasure;
+  %ignore openstudio::measure::OSRunner::getPastStepValuesForName;


Ignore new Json::Value returns

jmarrec · 2024-05-22T12:13:16Z

csharp/OpenStudio-osx-arm64.targets

jmarrec · 2024-05-22T12:13:40Z

csharp/developer/OpenStudio/OpenStudio.csproj.in

+    <Message Text="DEBUGGING: OS=$(OS) TargetFramework=$(TargetFramework) Architecture=$(Architecture) Platform=$(Platform) RID=$(Rid)" />
+    <Message Text="DEBUGGING: is_osx1=$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX))) is_osx2=$([MSBuild]::IsOsPlatform('OSX'))" />
+    <Message Text="DEBUGGING: System.Runtime.InteropServices.RuntimeInformation: OSArchitecture=$([System.Runtime.InteropServices.RuntimeInformation]::OSArchitecture), RuntimeIdentifier=$([System.Runtime.InteropServices.RuntimeInformation]::RuntimeIdentifier), OSDescription=$([System.Runtime.InteropServices.RuntimeInformation]::OSDescription)" />
+    <PropertyGroup>
+      <Rid>$([System.Runtime.InteropServices.RuntimeInformation]::RuntimeIdentifier)</Rid>
+      <IsLinux>$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Linux)))</IsLinux>
+      <IsDarwin>$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX)))</IsDarwin>
+      <IsWindows>$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Windows)))</IsWindows>
+      <IsArm64>False</IsArm64>
+      <IsArm64 Condition=" '$([System.Runtime.InteropServices.RuntimeInformation]::OSArchitecture)' == 'Arm64' ">true</IsArm64>
+    </PropertyGroup>
+    <Message Text="DEBUGGING: Rid=$(Rid), IsLinux=$(IsLinux), IsDarwin=$(IsDarwin), IsWindows=$(IsWindows), IsArm64=$(IsArm64), IsNotArm64=$(IsNotArm64)" />
+    <Message Condition=" $(IsDarwin) And !$(IsArm64) " Text="Darwin not arm64" />
+    <Message Condition=" $(IsDarwin) And $(IsArm64) " Text="Darwin arm64" />
    <!-- for Windows -->
-    <ItemGroup Condition="'$(OS)' == 'Windows_NT'">
+    <ItemGroup Condition=" $(IsWindows) ">
      <TfmSpecificPackageFile Include="../Products/Release/openstudio*csharp.dll" PackagePath="lib/$(TargetFramework)" />
      <TfmSpecificPackageFile Include="../Products/Release/openstudiolib.dll" PackagePath="lib/$(TargetFramework)" />
    </ItemGroup>

    <!-- for Linux -->
-    <ItemGroup Condition=" '$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Linux)))' ">
+    <ItemGroup Condition=" $(IsLinux) ">
      <TfmSpecificPackageFile Include="../Products/*openstudio*csharp.so" PackagePath="runtimes/linux-x64/native" />
      <TfmSpecificPackageFile Include="../Products/*openstudiolib.so" PackagePath="runtimes/linux-x64/native" />
      <TfmSpecificPackageFile Include="../Products/OpenStudio-linux-x64.targets" PackagePath="build/OpenStudio.targets" />
    </ItemGroup>

    <!-- for Mac  -->
-    <ItemGroup Condition=" '$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX)))' ">
+    <ItemGroup Condition=" $(IsDarwin) And !$(IsArm64) ">
      <TfmSpecificPackageFile Include="../Products/*openstudio*csharp.dylib" PackagePath="runtimes/osx-x64/native" />
      <TfmSpecificPackageFile Include="../Products/*openstudiolib.dylib" PackagePath="runtimes/osx-x64/native" />
      <TfmSpecificPackageFile Include="../Products/OpenStudio-osx-x64.targets" PackagePath="build/OpenStudio.targets" />
    </ItemGroup>
+    <ItemGroup Condition=" $(IsDarwin) And $(IsArm64) ">
+      <TfmSpecificPackageFile Include="../Products/*openstudio*csharp.dylib" PackagePath="runtimes/$(Rid)/native" />
+      <TfmSpecificPackageFile Include="../Products/*openstudiolib.dylib" PackagePath="runtimes/$(Rid)/native" />
+      <TfmSpecificPackageFile Include="../Products/OpenStudio-$(Rid).targets" PackagePath="build/OpenStudio.targets" />
+    </ItemGroup>


New to support osx-arm64

jmarrec · 2024-05-22T12:16:01Z

csharp/developer/OpenStudio/OpenStudio.csproj.in

      <TfmSpecificPackageFile Include="../Products/*openstudio*csharp.dylib" PackagePath="runtimes/osx-x64/native" />
      <TfmSpecificPackageFile Include="../Products/*openstudiolib.dylib" PackagePath="runtimes/osx-x64/native" />
      <TfmSpecificPackageFile Include="../Products/OpenStudio-osx-x64.targets" PackagePath="build/OpenStudio.targets" />
    </ItemGroup>
+    <ItemGroup Condition=" $(IsDarwin) And $(IsArm64) ">
+      <TfmSpecificPackageFile Include="../Products/*openstudio*csharp.dylib" PackagePath="runtimes/$(Rid)/native" />


Note that for mac, I could just use a single block... But I was wary of maybe breaking something, and after about 25 runs of the C# workflow (some of which I have to wait almost 2 hours to see if breaks), I just didn't want to risk it

<ItemGroup Condition=" $(IsDarwin) "> <TfmSpecificPackageFile Include="../Products/*openstudio*csharp.dylib" PackagePath="runtimes/$(Rid)/native" /> <TfmSpecificPackageFile Include="../Products/*openstudiolib.dylib" PackagePath="runtimes/$(Rid)/native" /> <TfmSpecificPackageFile Include="../Products/OpenStudio-$(Rid).targets" PackagePath="build/OpenStudio.targets" /> </ItemGroup>

jmarrec · 2024-05-22T12:16:41Z

src/utilities/core/jsoncpp.i

@@ -5,6 +5,7 @@
  // ignores toJSON/fromJSON globally
  %rename("$ignore", regextarget=1, fullname=1) "openstudio::.*::toJSON$";
  %rename("$ignore", regextarget=1, fullname=1) "openstudio::.*::fromJSON$";
+  %rename("$ignore", regextarget=1, fullname=1) "openstudio::.*::valueAsJSON$";


New global ignore

MingboPeng · 2024-05-23T17:49:09Z

Alright 3.8.0 packages, including the new osx-arm64 are available on this run: https://github.com/NREL/OpenStudio/actions/runs/9189117111/job/25275666930

@kbenne I hosted the windows (that contains both win32 and x64) on https://www.nuget.org/packages/OpenStudio/3.8.0

@MingboPeng FYI if you want to upload them to your nuget packages per platform.

Thanks @jmarrec, done! The new NuGet packages are added per platform including arm64 for mac.

jmarrec added 4 commits May 21, 2024 22:33

Add i386 hash from my forked release of E+

63c72a6

Port C# workflow for conan v2 + add arm64

2580d5f

Rebuild v3.8.0 with patched cmakelists (E+ x86 sha)

13d091c

Force build swig on ubuntu + use conan-default preset for MSVC multi …

4391413

…config Ubuntu: got “PCRE regex matching is not available in this SWIG build” ?

jmarrec added Developer Issue component - C# labels May 21, 2024

jmarrec self-assigned this May 21, 2024

jmarrec force-pushed the CSharp branch from 80dae37 to 8153bff Compare May 21, 2024 22:10

Modified the swig recipe (my fork of conan-center) to properly enable…

898030e

… PRCE

jmarrec force-pushed the CSharp branch from 8153bff to 898030e Compare May 21, 2024 22:13

Try again for PCRE support in swig...

62c04a5

jmarrec closed this May 21, 2024

jmarrec added 8 commits May 22, 2024 01:25

C# Ignore new return types of Json::Value type. Build works on mac

359f6cb

Try again for swig+pcre on windows

ed34ec1

I'm confused, on windows64 sometimes the preset is called conan-defau…

2ad82d4

…lt, sometimes conan-release?

Ok I think I got it: you configure with conan-default and build with …

44c81c6

…conan-release

I need to apply the .i changes too... Probably shoudl do a git reset …

2a0d5dd

…instead

Allow disabling with_ruby. We don't need it for C#, and it fails to b…

91142f1

…uild on win32

Meh, just stop trying to pass a full reference for options

920a3a4

adjust test part runner matrix

e852177

jmarrec reopened this May 22, 2024

jmarrec marked this pull request as ready for review May 22, 2024 06:32

jmarrec requested review from kbenne and wenyikuang May 22, 2024 06:33

Fixup C# native paths on osx-arm64 and use a git reset --soft

9f42c17

jmarrec force-pushed the CSharp branch from b13ed79 to 9f42c17 Compare May 22, 2024 09:49

BUILD_CLI=OFF if no ruby

7520ae2

Undo rebuilding v3.8.0 specifically [skip ci]

8d7675f

jmarrec commented May 22, 2024

View reviewed changes

jmarrec merged commit cdee54c into develop May 22, 2024

jmarrec deleted the CSharp branch May 22, 2024 12:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CSharp - Update for conan V2 and build for 3.8.0 (+ add arm64) #5211

CSharp - Update for conan V2 and build for 3.8.0 (+ add arm64) #5211

jmarrec commented May 21, 2024

jmarrec commented May 21, 2024

jmarrec commented May 22, 2024

jmarrec May 22, 2024

jmarrec May 22, 2024

jmarrec May 22, 2024

jmarrec May 22, 2024

jmarrec May 22, 2024

jmarrec May 22, 2024

jmarrec May 22, 2024

MingboPeng commented May 23, 2024

CSharp - Update for conan V2 and build for 3.8.0 (+ add arm64) #5211

CSharp - Update for conan V2 and build for 3.8.0 (+ add arm64) #5211

Conversation

jmarrec commented May 21, 2024

Pull request overview

Pull Request Author

Review Checklist

jmarrec commented May 21, 2024

jmarrec commented May 22, 2024

jmarrec May 22, 2024

Choose a reason for hiding this comment

jmarrec May 22, 2024

Choose a reason for hiding this comment

jmarrec May 22, 2024

Choose a reason for hiding this comment

jmarrec May 22, 2024

Choose a reason for hiding this comment

jmarrec May 22, 2024

Choose a reason for hiding this comment

jmarrec May 22, 2024

Choose a reason for hiding this comment

jmarrec May 22, 2024

Choose a reason for hiding this comment

MingboPeng commented May 23, 2024