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

Move engine methods utilising serialisation to Adapter Execute #153

Merged
merged 31 commits into from
Dec 1, 2023

Conversation

Tom-Kingstone
Copy link
Contributor

@Tom-Kingstone Tom-Kingstone commented Nov 29, 2023

NOTE: Depends on

Issues addressed by this PR

Closes #143

The engine methods: GetMaterial, GetTypology, SimulationResult, and ExternalComfort have been converted to adapter methods callable by Execute commands, that now utilise the LadybugToolsAdapter serialisation methods.

Test files

LBT_Tests.zip
Ensure the EPW file path is valid, then set toggles to True in order (GetMaterial, GetTypology, SimulationResult, ExternalComfort) and wait for them to finish computing, check for any warnings or errors, and finally check that the returning objects contain data in each property - This is testing whether the serialiser is pulling and pushing correctly.

Additional comments

You must have pollination version 1.35.14 installed for these components to work - the methods check for this.

@Tom-Kingstone Tom-Kingstone added the type:feature New capability or enhancement label Nov 29, 2023
@Tom-Kingstone Tom-Kingstone self-assigned this Nov 29, 2023
@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check compliance
@BHoMBot check core

Copy link

bhombot-ci bot commented Nov 29, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance
  • check core

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check core

Copy link

bhombot-ci bot commented Nov 29, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check core

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check compliance

Copy link

bhombot-ci bot commented Nov 29, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check compliance
@BHoMBot check required

Copy link

bhombot-ci bot commented Nov 29, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance
  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check core
  • check null-handling
  • check serialisation
  • check versioning
  • check installer

Copy link

bhombot-ci bot commented Nov 29, 2023

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link

bhombot-ci bot commented Nov 29, 2023

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link

bhombot-ci bot commented Nov 29, 2023

The check project-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed on a call, Engine shouldn't use Adapter - @Tom-Kingstone will take a look at using Execute options instead and update the PR accordingly tomorrow/later int he week 😄

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check copyright-compliance

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone fix requested for copyright headers.

The errors with the copyright headers on the CS (.cs) files have been recorded as annotations on the checks tab.

I will apply the fixes to every case detailed on the checks tab. If you want to perform the fixes in a different manner please resolve this manually and rerun the check.

Each CS (.cs) file that does not have the current copyright header will have it applied. The current copyright header can be examined here.

If you are happy for me to go ahead and perform this action, please reply with:

@BHoMBot fix copyright headers ref. 19180266457

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot fix copyright headers ref. 19180266457

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone I have queued up your request to fix copyright headers. There are 0 requests in the queue ahead of you.

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone I am now going to fix the copyright compliance in accordance with the annotations previously made.

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone to confirm I have now resolved the copyright compliance and pushed a commit to this Pull Request.

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check compliance
@BHoMBot check core

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance
  • check core

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check versioning

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check versioning

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the adapter references, of which only Adapter_oM is needed, should have gone into the oM project, not the engine project?

LadybugTools_Engine/LadybugTools_Engine.csproj Outdated Show resolved Hide resolved
@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check compliance
@BHoMBot check core

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance
  • check core

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check compliance
@BHoMBot check required

Copy link

bhombot-ci bot commented Nov 30, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance
  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check core
  • check null-handling
  • check serialisation
  • check versioning
  • check installer

Copy link

bhombot-ci bot commented Nov 30, 2023

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link

bhombot-ci bot commented Nov 30, 2023

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link

bhombot-ci bot commented Nov 30, 2023

The check project-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not great with the global variable but as discussed offline, not a lot we can do right now, so we'll merge this as a working solution for alpha testing and we can have more chats on improvements @Tom-Kingstone

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check installer
@BHoMBot check unit-tests
@BHoMBot check ready-to-merge

Copy link

bhombot-ci bot commented Dec 1, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check installer
  • check unit-tests
  • check ready-to-merge

@Tom-Kingstone
Copy link
Contributor Author

@BHoMBot check ready-to-merge

Copy link

bhombot-ci bot commented Dec 1, 2023

@Tom-Kingstone to confirm, the following actions are now queued:

  • check ready-to-merge

@FraserGreenroyd FraserGreenroyd merged commit a3d06f8 into develop Dec 1, 2023
13 checks passed
@FraserGreenroyd FraserGreenroyd deleted the LadybugTools_Toolkit-#143-UseAdapterInEngine branch December 1, 2023 15:24
@bhombot-ci bhombot-ci bot mentioned this pull request Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature New capability or enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Engine methods to use adapter for serialisation
3 participants