Add documentation for high level FLORIS architecture#630
Merged
rafmudaf merged 3 commits intoNatLabRockies:developfrom Apr 26, 2023
Merged
Add documentation for high level FLORIS architecture#630rafmudaf merged 3 commits intoNatLabRockies:developfrom
rafmudaf merged 3 commits intoNatLabRockies:developfrom
Conversation
paulf81
approved these changes
Apr 25, 2023
rafmudaf
force-pushed
the
docs/architecture
branch
from
b345f95 to
77a757e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
FLORIS software architecture
This pull request adds a first-pass description of the FLORIS architecture at a relatively high level. The packages at
floris.*are described as well as the general architecture and class relationships offloris.simulation. The objective is to establish the initial architecture and provide a place for ongoing descriptions of architectural changes.As a small aside, I also made a couple of functions in
floris.type_decthat make two functions private (prefix with_) that were previously denoted as public.Impacted areas of the software
Developer docs and
floris.type_dec