bump version to 0.5.0

CHANGELOG.md

@@ -6,12 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## [Unreleased]
+
+
+## [0.5.0] - 2024-02-06
 ### Added
-- unit tests for materialdatabase
+- various integration tests, unit tests for materialdatabase
 - three winding transformer
 - center-tapped transformer drawing schemes
+- stacked transformer
 - parallel connection of solid turns
 
+### Changed
+- API has lots of changes. Check out the examples and the documentation.
+
 ### Updated
 - materialdatabase: material loading and interpolation of operation point
 
@@ -118,7 +125,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - add femmt/SolidComp.py
 - add femmt/CompRes.py
 
-[Unreleased]: https://github.com/upb-lea/transistordatabase/compare/0.4.0...HEAD
+[Unreleased]: https://github.com/upb-lea/transistordatabase/compare/0.5.0...HEAD
+[0.5.0]: https://github.com/upb-lea/transistordatabase/compare/0.5.0...0.4.0
 [0.4.0]: https://github.com/upb-lea/transistordatabase/compare/0.4.0...0.3.0
 [0.3.0]: https://github.com/upb-lea/transistordatabase/compare/0.3.0...0.2.1
 [0.2.1]: https://github.com/upb-lea/transistordatabase/compare/0.2.0...0.2.1

documentation/source/conf.py

@@ -13,7 +13,7 @@
 import os
 import sys
 import time
-sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
 
 
 # -- Project information -----------------------------------------------------
@@ -23,7 +23,7 @@
 author = 'LEA-UPB'
 
 # The full version, including alpha/beta/rc tags
-release = '0.4.0'
+release = '0.5.0'
 
 # -- General configuration ---------------------------------------------------
 

documentation/source/developer_notes.rst

@@ -13,7 +13,7 @@ The variable naming is defined as shown in this section. Note that the names sho
 |geometry_core_naming_convention|
 
 Geometry variables
-###################
+~~~~~~~~~~~~~~~~~~
 * ``core_inner_diameter``: core inner diameter
 * ``window_w``: width of winding window
 * ``winding_h``: height of winding window
@@ -25,12 +25,12 @@ Additional variables for integrated transformer
 * ``window_h_bot``: height of bottom winding window
 
 currents, temperature
-#####################
+~~~~~~~~~~~~~~~~~~~~~
 * ``temperature``: temperature (Do **not** use ``T``, ``temp``, ...)
 * ``frequency``: frequency (Do **not** use ``f``, ``freq``, ...)
 
 Material variables
-###################
+~~~~~~~~~~~~~~~~~~
 * ``mu_r_abs``: absolute value of mu_r
 * ``mu_r_real``: real part of mu_r
 * ``mu_r_imag``: imaginary part of mu_r
@@ -85,19 +85,19 @@ Recommended Pycharm settings
 ---------------------------------------------------------------
 
 Exclude simulation directory from indexing
-#########################################################
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Especially when performing Pareto optimizations in the example directory, Pycharm gets slow during indexing. To avoid this, you can use another directory or exclude the ``example_results`` direcory from the project, as shown in the following steps:
 ``File`` -> ``Settings`` -> ``project structure``, select the folders you need (e.g. ``femmt/examples/example_results``, ``right click`` and click ``exlcuded``.
 
 Line length
-#########################################################
+~~~~~~~~~~~
 
 ``File`` -> ``Settings`` -> ``Editor`` -> ``Code Style``
 Set the max. lenth to ``160``.
 
 Pycharm code highlightning for pro-files
-#########################################################
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 |image_pycharm_configuration_pro_files|
 
@@ -117,3 +117,7 @@ also run
 ``ruff check $(git ls-files '*.py')``
 
 For windows users, use the pycharm integrated ``Git Bash``.
+
+Build documentation
+---------------------------------------------------------------
+``sphinx-multiversion documentation/source documentation/build/html``

documentation/source/user_guide_model_creation.rst

@@ -145,7 +145,7 @@ Furthermore there are offset insulations between each turn in the same
 winding, a distance between 2 windings in one virtual winding window and
 a distance between each virtual winding window. The first two are set
 using the ``add_winding_insulations`` functions, the last one when
-creating such a :ref:`virtual winding windows` (vww).
+creating such a :ref:`virtual-winding-windows-label` (vww).
 
 The ``add_winding_insulations`` contains the inner winding insulation, which is a nested lists representing
 the insulations between turns of the same winding. Importantly, these values are not arranged according to the
@@ -569,14 +569,14 @@ Here is an example of how the outcomes of frequency domain simulation are struct
         {
           "f": 200000,
           "winding1": {
-            "turn_losses": [...],
+            "turn_losses": ["..."],
             "flux": [6.34870443074174e-06, -6.969982393761393e-07],
             "flux_over_current": [3.17434773053773e-06, -3.51948446513906e-07],
             "V": [0.8845429232083418, 7.978006008157411],
-            ...
+            "..."
           },
           "winding2": {
-            ...
+            "..."
           },
           "core_eddy_losses": 0.00050908155779138,
           "core_hyst_losses": 3.16018326710339,
@@ -586,14 +586,15 @@ Here is an example of how the outcomes of frequency domain simulation are struct
               "hyst_losses": 3.16018326710339,
               "total_core_part_1": 3.259745103293544
             }
-          ...
+          "..."
           "all_winding_losses": 0.5355581006243983
+          }
         }
       ],
       "total_losses": {
         "winding1": {
           "total": 0.5355581006244025,
-           "turns": [...]
+           "turns": ["..."]
         }
         "all_windings": 0.5355581006243983,
         "eddy_core": 0.09956183619015413,
@@ -604,6 +605,7 @@ Here is an example of how the outcomes of frequency domain simulation are struct
         "core": 3.259745103293544,
         "total_losses": 3.7953032039179426
      }
+    }
 
 **Key Components Explained:**
 
@@ -672,7 +674,7 @@ Here is an example of how the outcomes of time domain simulation are structured.
                 "I": 2.0
               },
               "winding2": {
-                ... }}}
+                "..." }}}
         },
         {
          "...": {}
@@ -689,7 +691,7 @@ Here is an example of how the outcomes of time domain simulation are structured.
           "S": 4.5274565545301515,
           "Q": 4.469775429993662
         },
-        "winding2": {...}
+        "winding2": {"..."}
       },
       "total_losses": {
         "all_windings_losses": 2.511429275334878,
@@ -743,13 +745,13 @@ simulation. The outcomes of thermal simulation are structured as:
         }
       },
       "windings": {
-        "winding_0_0": {...},
-        "winding_0_1": {...},
-        "winding_0_2": {...},
-        "winding_1_0": {...},
-        "winding_1_1": {...},
-        "winding_1_2": {...},
-        "total": {...}
+        "winding_0_0": {"..."},
+        "winding_0_1": {"..."},
+        "winding_0_2": {"..."},
+        "winding_1_0": {"..."},
+        "winding_1_1": {"..."},
+        "winding_1_2": {"..."},
+        "total": {"..."}
       },
       "misc": {
         "case_volume": 0.00017214993340642786,

setup.py

@@ -66,7 +66,7 @@
         "Documentation": "https://upb-lea.github.io/FEM_Magnetics_Toolbox/main/intro.html",
         "Source Code": "https://github.com/upb-lea/FEM_Magnetics_Toolbox",
     },
-    version='0.4.0',
+    version='0.5.0',
     zip_safe=False,
     data_files=[('', ['CHANGELOG.md'])]
 )