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.

Sign up for GitHub

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

Jump to bottom

Update documentation, reorganize example scripts #148

Merged
merged 36 commits into from
Aug 25, 2024
Merged

Update documentation, reorganize example scripts #148

merged 36 commits into from
Aug 25, 2024

Conversation

maattaj11
Copy link
Contributor

This pull request contains updates to the documentation, including:

  • Refactoring of the documentation structure to facilitate addition of grid converter sections
  • Addition of grid models section adapted from gritulator, new grid control sections
  • Division of example scripts into drive and grid subdirectories
  • Refactoring of grid imports to use the same convention as in drive package

maattaj11 and others added 26 commits August 19, 2024 14:22
@maattaj11
add updated documentation
d4a0691
@maattaj11
edited gitignore
761a490
@MiSaren
updated complexFFPI current controller diagram. Now uses complex vect…
15ca070 
…or design instead of IMC
@MiSaren
Merge pull request #62 from MiSaren/main
e0de5cd 
Refactoring (Aalto-Electric-Drives#146)
@maattaj11
refactored imports: CarrierComparison, Simulation and VoltageSourceCo…
194cdcd 
…nverter are now imported as part of grid.model package. BaseValues and NominalValues classes are defined in common/utils/ and imported into drive.utils and grid.utils
@maattaj11
updated example scripts to use new import structure
9d73ea4
@maattaj11
Merge branch 'update-imports' into update-docs
28c5338
@maattaj11
Merge branch 'update-docs' of https://github.com/MiSaren/motulator in…
380ad8d 
…to update-docs
@maattaj11
move example scripts into separate drive and grid subfolders
615637a
@MiSaren
updated equations in gfl current controller
155146f
@MiSaren
documentation layout updated
654c112
@maattaj11
updated Usage section, fix to conf.py
61ed55c
@MiSaren
links fixed in documentation, all examples. and also most of the mode…
c8fa3d1 
…ls and control
@maattaj11
updated grid voltage source documentation
77e8553
@maattaj11
small fixes in documentation, removed unnecessary comment from common…
5bd0640 
….model
@maattaj11
edited section names in control docs
2e79952
@maattaj11
readded CarrierComparison to common.model init to fix some links in d…
195c067 
…ocumentation, fixed import in CarrierComparison docstring usage example
@maattaj11
set autoapi option to have api reference in alphabetical order, chang…
5261038 
…e import in common/model/converter.py to fix some links in api reference
@MiSaren
removed conductances
f21a126
@maattaj11
Merge branch 'main' into update-docs
3f5cc89
@maattaj11
Merge branch 'update-docs' of https://github.com/MiSaren/motulator in…
c3e6ce2 
…to update-docs
@maattaj11
fix import in IM flux vector example, fix cross-references in GFM exa…
79f7c95 
…mple readme
@MiSaren
LC- and L-filter figures updates
b8d189b
@maattaj11
modified notation in grid filter documentation, added an exception th…
9b7787a 
…at is raised if ACFilter is not given correct parameters
@MiSaren
modified generic system model section, added describtion of the main …
96fa36a 
…control loop
@maattaj11
updated converter documentation and figures
0ae0491
@mhinkkan mhinkkan self-requested a review August 22, 2024 14:08
@mhinkkan mhinkkan requested review from jarno-k and rayanmour August 22, 2024 14:09
maattaj11 and others added 8 commits August 22, 2024 17:14
@maattaj11
added observer section to Synchronization, removed unnecessary newlines
5543385
@maattaj11
edits to documentation structure: removed sections that will be impro…
824ec33 
…ved and included in a later PR, removed mentions to future extensions on some pages
@maattaj11
renamed Generic System Model section to Introduction, moved main cont…
a1aab2f 
…rol loop description to a separate page under Design notes
@MiSaren
updated converter figures i_ext -> i_dc, i_dc -> i_dc'. The same chan…
cef9cc7 
…ge in equations and text. Notation changed to follow normal convention in the text books.
@MiSaren
grid filter, equation notation fixed
0f4020d
@MiSaren
U_gN -> u_gN in PLL section
4e2df71
@maattaj11
changed grid.control folder structure to simplify imports in examples…
6453727 
…, all grid converter control-related classes are now imported directly from motulator.grid.control
@maattaj11
Merge pull request #63 from MiSaren/update-docs-fixes
3c6a26e 
Fixes to documentation
@mhinkkan
Copy link
Member

Thanks again for the PR! I will merge this now and do some minor refactoring and simplifications in a separate PR.

@mhinkkan mhinkkan merged commit 9103cc4 into Aalto-Electric-Drives:main Aug 25, 2024
1 check passed
@MiSaren MiSaren deleted the update-docs branch August 28, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mhinkkan mhinkkan Awaiting requested review from mhinkkan

@jarno-k jarno-k Awaiting requested review from jarno-k

@rayanmour rayanmour Awaiting requested review from rayanmour

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@maattaj11 @mhinkkan @MiSaren