point out that time domain simulation is experimental

upb-lea · Jul 29, 2024 · 3a6b3ac · 3a6b3ac
1 parent a10d983
commit 3a6b3ac
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## [Unreleased]
+### Added
+- Winding schemes for square and foil windings
+
+### Changed
+- give time domain simulation examples the prefix 'experimental_' to avoid misunderstandings
+
+### Fixed
+- Add winding insulation to the inductor optimization example
+- Fixed many GUI issues. GUI is still experimental
+
+
 ## [0.5.4] - 2024-07-01
 ### Fixed
 - Require materialdatabase 0.3.0 for full materials compatibility 

diff --git a/README.rst b/README.rst
@@ -73,7 +73,7 @@ Experimental features (under development)
 * Component features:
     * Reluctance module is currently working for a single optimization example and not fully implemented yet.
 * Solver features:
-    * Time domain solver
+    * Time domain solver is experimental
 * Optimization:
     * Advanced optimization algorithms by connecting to `optuna <https://github.com/optuna/optuna>`__
 * GUI:

diff --git a/femmt/examples/basic_inductor_time_domain.py → ...ples/experimental_inductor_time_domain.py b/femmt/examples/basic_inductor_time_domain.py → ...ples/experimental_inductor_time_domain.py
diff --git a/..._transformer_three_winding_time_domain.py → ..._transformer_three_winding_time_domain.py b/..._transformer_three_winding_time_domain.py → ..._transformer_three_winding_time_domain.py
diff --git a/...examples/basic_transformer_time_domain.py → ...s/experimental_transformer_time_domain.py b/...examples/basic_transformer_time_domain.py → ...s/experimental_transformer_time_domain.py
diff --git a/tests/integration/test_femmt.py b/tests/integration/test_femmt.py
@@ -17,8 +17,9 @@
 import femmt.examples.basic_transformer_n_winding
 import femmt.examples.advanced_inductor_sweep
 import femmt.examples.basic_transformer_5_windings
-import femmt.examples.basic_inductor_time_domain
-import femmt.examples.basic_transformer_time_domain
+import femmt.examples.experimental_inductor_time_domain
+import femmt.examples.experimental_transformer_time_domain
+import femmt.examples.experimental_transformer_three_winding_time_domain
 import femmt.examples.advanced_inductor_air_gap_sweep
 import femmt.examples.component_study.transformer_component_study
 import femmt.examples.basic_transformer_excitation_sweep
@@ -2396,21 +2397,21 @@ def test_basic_example_transformer_5_windings(temp_folder):
 def test_basic_inductor_time_domain(temp_folder):
     """Integration test to test the basic example file."""
     temp_folder_path, onelab_folder = temp_folder
-    femmt.examples.basic_inductor_time_domain.basic_example_inductor_time_domain(onelab_folder=onelab_folder,
+    femmt.examples.experimental_inductor_time_domain.basic_example_inductor_time_domain(onelab_folder=onelab_folder,
                                                                                  show_visual_outputs=False,
                                                                                  is_test=True)
 
 def test_basic_transformer_time_domain(temp_folder):
     """Integration test to test the basic example file."""
     temp_folder_path, onelab_folder = temp_folder
-    femmt.examples.basic_transformer_time_domain.basic_example_transformer_time_domain(onelab_folder=onelab_folder,
+    femmt.examples.experimental_transformer_time_domain.basic_example_transformer_time_domain(onelab_folder=onelab_folder,
                                                                                        show_visual_outputs=False,
                                                                                        is_test=True)
 
 def test_basic_transformer_3_windings_time_domain(temp_folder):
     """Integration test to test the basic example file."""
     temp_folder_path, onelab_folder = temp_folder
-    femmt.examples.basic_transformer_three_winding.basic_example_transformer_three_winding(onelab_folder=onelab_folder,
+    femmt.examples.experimental_transformer_three_winding_time_domain.basic_example_transformer_three_windings_time_domain(onelab_folder=onelab_folder,
                                                                                            show_visual_outputs=False,
                                                                                            is_test=True)
 def test_advanced_example_inductor_sweep(temp_folder):