|
1 | | -# v0.5.0 Draft |
| 1 | +# v0.6.0 Draft |
2 | 2 | *Comming soon!* |
3 | 3 |
|
4 | | -## New Features |
5 | | -* Geometry import: |
6 | | - * Functions to read `.STP` files, exporting each solid into an `.STL` file indicating the name and material: `wakis.geometry.generate_stl_solids_from_stp(stp_file)` |
7 | | - * Functions to extract from `.STP` files `solid` names, `colors`, and `materials`: `wakis.geometry.extract_XXX(stp_file)` to easily build the input dictionaries needed for `GridFIT3D` |
| 4 | +## 🚀 New Features |
| 5 | +* SolverFIT3D |
| 6 | + * Multi-CPU simulations using the slicing method and `mpi4py` |
8 | 7 |
|
9 | | -* Solver: |
10 | | - * New maximal timestep calculation for high-conductive regions based on CFL + relaxation time criterion |
11 | | - * New methods: `save_state()`, `load_state()` to export and import the fields at a particular simulation timestep (HDF5 format). Method `reset_fields()` to clear fields before restarting a simulation. |
12 | | - * Perfect Matching Layers (PML) boundary conditions: First version out! |
| 8 | +## 💗 Other Tag highlights |
| 9 | +* 🔁 Nightly tests with GitHub actions: |
| 10 | +* 📁 Examples: 003 -> MPI wakefield simulation |
| 11 | +* 📁 Notebooks: 005 -> MPI example |
13 | 12 |
|
14 | | -* Plotting: |
15 | | - * `solver.plot3DonSTL` Field on STL solid using `pyvista.sample` interpolation algorithm |
16 | | - * Interactive plane clipping on `plot3DonSTL` |
17 | | - * Field shown on clipping plane |
18 | | - * `grid.plot_solids()` 3D plot with the imported solids and the position in the simulation bounding box when `bounding_box=True` |
| 13 | +## 🐛 Bugfixes |
| 14 | +* `__version__` now matches PyPI release and tag |
19 | 15 |
|
20 | | -* Sources: |
21 | | - * Add `plot(t)` method to plot the source over the simulation time `t` |
22 | | - * Custom amplitude as an attribute `self.amplitude` |
23 | | - * Custom phase as an attribute `self.phase` |
24 | | - * Custom injection time `self.tinj` |
25 | | - * For `PlaneWave` allow for truncation at specific number of `self.nodes` injected |
26 | 16 |
|
27 | | -* Ecosytem: |
28 | | - * Wake extrapolation of partially decayed wakes coupling with [`IDDEFIX`]: https://github.com/ImpedanCEI/IDDEFIX: |
29 | | - * IDDEFIX is a physics-informed machine learning framework that fits a resonator-based model (parameterized by R, f, Q) to wakefield simulation data using Evolutionary Algorithms. It leverages Differential Evolution to optimize these parameters, enabling efficient classification and extrapolation of electromagnetic wakefield behavior. This allows for reduced simulation time while maintaining long-term accuracy, akin to time-series forecasting in machine learning |
| 17 | +## 👋👩💻New Contributors |
30 | 18 |
|
31 | | - * Impedance to wake function conversion using non-equidistant fourier transform with: [`neffint]: https://github.com/ImpedanCEI/neffint |
32 | | - * Neffint is an acronym for Non-equidistant Filon Fourier integration. This is a python package for computing Fourier integrals using a method based on Filon's rule with non-equidistant grid spacing. |
33 | 19 |
|
34 | | - * Beam-induced power loss calculations for different beam shapes and filling schemes using ['BIHC`]: https://github.com/ImpedanCEI/BIHC |
35 | | - * Beam Induced Heating Computation (BIHC) tool is a package that allows the estimation of the dissipated power due to the passage of a particle beam inside an accelerator component. The dissipated power value depends on the characteristics of the particle beam (beam spectrum and intensity) and on the characteristics of the consdiered accelerator component (beam-coupling impedance). |
| 20 | +## 📝Full changelog |
| 21 | +`git log v0.5.0... --date=short --pretty=format:"* %ad %d %s (%aN)" | copy` |
36 | 22 |
|
37 | | -## Other Tag highlights |
38 | | -* Nightly tests with Github actions [000 - 005] |
39 | | -* :file_folder: notebooks: containing interactive examples |
40 | | -* :file_folder: examples: major cleanup, examples on CPU and GPU |
41 | | - |
42 | | -## Bugfixes |
43 | | -* Patch representation when a list is passed in `Plot2D` |
44 | | -* `ipympl` added as a dependency to `wakis['notebook']` installation |
45 | | -* Injection time to account for relativistic beta in sources |
46 | | - |
47 | | -## Full Changelog |
48 | | -`git log v0.4.0... --date=short --pretty=format:"* %ad %d %s (%aN)" | copy` |
49 | | - |
50 | | -* 2025-03-06 feature: first ipyparallel+MPI example for running simulations on notebooks (elenafuengar) |
51 | | -* 2025-03-06 fix: update_mpi needs only zmin as argument, not vector z (elenafuengar) |
52 | | -* 2025-03-06 feature: first working example with MPI (needs more iterations to be perfect) (elenafuengar) |
53 | | -* 2025-03-04 fix: support saving state from GPU (elenafuengar) |
54 | | -* 2025-03-04 feature: pass figure size as argument (elenafuengar) |
55 | | -* 2025-03-04 fix: variable nodes was not used (elenafuengar) |
56 | | -* 2025-03-04 fix: remove redundant check for stl_colors None -> it is handled in init through assign_colors (elenafuengar) |
57 | | -* 2025-03-04 fix: error handling for stl colors, users opacity and specular, anti-aliasing can be set to None, and update docstring (elenafuengar) |
58 | | -* 2025-03-03 feature: first steps towards MPI (elenafuengar) |
59 | | -* 2025-03-03 style: add copy header (elenafuengar) |
60 | | -* 2025-02-25 docs: update release.md (elenafuengar) |
61 | | -* 2025-02-25 new test: geometry utils functions to extract information from STP files (elenafuengar) |
62 | | -* 2025-02-25 feature: Functions to extract from `.STP` files `solid` names, `colors`, and `materials`: `wakis.geometry.extract_XXX(stp_file)` to easily build the input dictionaries needed for `GridFIT3D` (elenafuengar) |
63 | | -* 2025-02-25 tests: update to new benchmark results for the new dt calculation (elenafuengar) |
64 | | -* 2025-02-25 style: revise plots and comments, adding emnedded results (elenafuengar) |
65 | | -* 2025-02-25 fix: use flag to apply the relaxation time criterion (elenafuengar) |
66 | | -* 2025-02-24 docs: update release.md (elenafuengar) |
67 | | -* 2025-02-24 feature: new method `solver.reset_fields()` to re-initialize all the fields to zero (elenafuengar) |
68 | | -* 2025-02-24 fix: avoid divide by zero with PEC materials in maximal timestep (elenafuengar) |
69 | | -* 2025-02-21 new test: PML boundaries with planewave source (elenafuengar) |
70 | | -* 2025-02-21 feature: improving maximal stable timestep calculation for lossy media adding the relaxation time criterion (elenafuengar) |
71 | | -* 2025-02-21 feature: supporting several cut positions-> `pos` can now be a list of 0-1 values (elenafuengar) |
72 | | -* 2025-02-21 fix: update PML default parameters to best performing and add epsilon (elenafuengar) |
73 | | -* 2025-02-21 feature: add `save_state`, `load_state` and `read_state` routines (elenafuengar) |
74 | | -* 2025-02-19 docs: update release.md (elenafuengar) |
75 | | -* 2025-02-19 feature: functions to extract solids and materials from stl file and convert them to .stl files importable in wakis (elenafuengar) |
76 | | -* 2025-02-19 feat: add new materials to library (elenafuengar) |
77 | | -* 2025-02-19 fix: use f instead of nodes (2) (elenafuengar) |
78 | | -* 2025-02-18 fix: use f instead of nodes (elenafuengar) |
79 | | -* 2025-02-18 refactor/feature: PlaneWave -> adding phase attribute, adding plot(t) method, change `nodes` to be the number of peaks to be injected (elenafuengar) |
80 | | -* 2025-02-18 fix: bugfix in z-dimension spacing (elenafuengar) |
81 | | -* 2025-02-18 fix: change the default to "all" in `update_tensors() (elenafuengar) |
82 | | -* 2025-02-17 style: remove FIT from plot title (elenafuengar) |
83 | | -* 2025-02-17 style: comment material units (elenafuengar) |
84 | | -* 2025-02-14 feature: add `plot_from` as parameter (elenafuengar) |
85 | | -* 2025-02-13 test: add reflection calculation and parametric scan (elenafuengar) |
86 | | -* 2025-02-12 refactor: move solver routines methods to RoutinesMixin in routines.py (elenafuengar) |
87 | | -* 2025-02-10 docs: add neffint reference (elenafuengar) |
88 | | -* 2025-02-10 test: PML test in progress (elenafuengar) |
89 | | -* 2025-02-10 refactor: move solving routines to Mixin class for code clarity (elenafuengar) |
90 | | -* 2025-02-10 feature: expose pml attributes, update PML filling routine, use RoutinesMixin (elenafuengar) |
91 | | -* 2025-02-10 feature: add deepcopy method copy() (elenafuengar) |
92 | | -* 2025-02-10 add changelog since v0.4.0 (elenafuengar) |
93 | | -* 2025-02-07 fix: use tilde quantities (elenafuengar) |
94 | | -* 2025-02-07 fix: pass anti_aliasing argument to pyvista (elenafuengar) |
95 | | -* 2025-02-07 fix: add bc_high to logical checks in `apply_bc_to_c` (elenafuengar) |
96 | | -* 2025-02-06 docs: update new features (elenafuengar) |
97 | | -* 2025-02-06 refactor: move benchmarks to satellite repository (elenafuengar) |
98 | | -* 2025-02-06 fix: revised notebook with embedded html firgures (2) (elenafuengar) |
99 | | -* 2025-02-06 docs: add troubleshooting for headless monitors (elenafuengar) |
100 | | -* 2025-02-06 fix: revised notebook with embedded html firgures (elenafuengar) |
101 | | -* 2025-02-06 feat: allow to pass amplitude as attribute (elenafuengar) |
102 | | -* 2025-02-06 feat: in `plot_solids()` add SSAA atialiasing, bounding box and camera position. in `inspect()` add SSAA antialiasing and allow empty meshes (elenafuengar) |
103 | | -* 2025-02-01 add iddefix and bihc references (elenafuengar) |
104 | | -* 2025-01-28 remove admonition (elenafuengar) |
105 | | -* 2025-01-28 finalize contribution guide and add a snippet to Code of conduct (elenafuengar) |
106 | | -* 2025-01-27 Update 004_Wakefield_simulation_and_extrapolation.ipynb (Elena de la Fuente García) |
107 | | -* 2025-01-27 Update 004_Wakefield_simulation_and_extrapolation.ipynb (Elena de la Fuente García) |
108 | | -* 2025-01-24 Change in DE results to pass directly ndarray and not dict (Elena de la Fuente García) |
109 | | -* 2025-01-24 Merge pull request #7 from ImpedanCEI/wakis-iddefix-example (Elena de la Fuente García) |
110 | | -* 2025-01-24 (origin/wakis-iddefix-example) Added iddefix to example (Malthe Raschke Nielsen) |
111 | | -* 2025-01-24 add code of conduct (elenafuengar) |
112 | | -* 2025-01-24 first version of contributing.md (elenafuengar) |
113 | | -* 2025-01-23 change in load results (elenafuengar) |
114 | | -* 2025-01-23 remove cell outputs (elenafuengar) |
115 | | -* 2025-01-23 Add example to shouwcase IDDEFIX wake extrapolation (elenafuengar) |
116 | | -* 2025-01-23 revision and restructuring of the example (elenafuengar) |
117 | | -* 2025-01-23 minor update (elenafuengar) |
118 | | -* 2025-01-22 add logo to 3d plots when possible (elenafuengar) |
119 | | -* 2025-01-22 add logo and fix bug in grid.inspect() colors dict (elenafuengar) |
120 | | -* 2025-01-22 bugfix in gridFIT3 (elenafuengar) |
121 | | -* 2025-01-21 small typo (elenafuengar) |
122 | | -* 2025-01-21 add grid.plot_solids() to the example (elenafuengar) |
123 | | -* 2025-01-21 add assign_colors() routine and plot_solids to 3d plot imported solids (elenafuengar) |
124 | | -* 2025-01-21 add material_colors library (elenafuengar) |
125 | | -* 2025-01-21 remove pyvista plots since can cause seg fault on headless servers without x11 (elenafuengar) |
126 | | -* 2025-01-21 add GPU example (elenafuengar) |
127 | | -* 2025-01-21 add animation command (elenafuengar) |
128 | | -* 2025-01-21 add example of each plot type (elenafuengar) |
129 | | -* 2025-01-17 new release draft description (elenafuengar) |
130 | | -* 2025-01-16 fix typo and add 3d plotting snippet (elenafuengar) |
131 | | -* 2025-01-16 add example 001 content (elenafuengar) |
132 | | -* 2025-01-16 add stl files for example 001 (elenafuengar) |
133 | | -* 2025-01-15 update README (elenafuengar) |
134 | | -* 2025-01-14 add test for wake to impedance conversion (elenafuengar) |
135 | | -* 2025-01-14 add functions to go from wake function to impedance and viceversa, for any frequency span, resolution and number of samples (elenafuengar) |
136 | | -* 2025-01-10 new examples placeholders (elenafuengar) |
137 | | -* 2025-01-10 Moving scripts to subfolder (elenafuengar) |
138 | | -* 2025-01-10 minor fixes (elenafuengar) |
139 | | -* 2025-01-10 minor fixes (elenafuengar) |
140 | | -* 2025-01-10 Update requirements.txt (Elena de la Fuente García) |
141 | | -* 2025-01-02 Create CITATION.cff (Elena de la Fuente García) |
142 | | -* 2024-12-20 Update README.md (Elena de la Fuente García) |
143 | | -* 2024-12-20 fix version (elenafuengar) |
144 | | -* 2024-12-20 fix token name (elenafuengar) |
145 | | -* 2024-12-20 change to v3 (elenafuengar) |
146 | | -* 2024-12-20 remove slug (elenafuengar) |
147 | | -* 2024-12-20 change to dispatch (elenafuengar) |
148 | | -* 2024-12-20 change trigger (elenafuengar) |
149 | | -* 2024-12-20 change trigger (elenafuengar) |
150 | | -* 2024-12-20 fix comments (elenafuengar) |
151 | | -* 2024-12-20 fix comments (elenafuengar) |
152 | | -* 2024-12-20 change trigger (elenafuengar) |
153 | | -* 2024-12-20 fix identation (elenafuengar) |
154 | | -* 2024-12-20 adding codecov tests - trigger in 2 minutes (elenafuengar) |
155 | | -* 2024-12-20 adding codecov tests (elenafuengar) |
156 | | -* 2024-12-19 reorganize badges (elenafuengar) |
157 | | -* 2024-12-19 add nightly test badge (elenafuengar) |
158 | | -* 2024-12-19 revert to midnight (elenafuengar) |
159 | | -* 2024-12-19 test trigger UTC time (elenafuengar) |
160 | | -* 2024-12-19 test trigger (elenafuengar) |
161 | | -* 2024-12-19 delete typo (elenafuengar) |
162 | | -* 2024-12-19 add nightly tests (elenafuengar) |
163 | | -* 2024-12-18 add nightly tests (elenafuengar) |
164 | | -* 2024-12-18 generate h5 file inside tests folder (elenafuengar) |
165 | | -* 2024-12-18 fix actions (elenafuengar) |
166 | | -* 2024-12-18 mark all pyvista tests as interactive (elenafuengar) |
167 | | -* 2024-12-18 fix actions (elenafuengar) |
168 | | -* 2024-12-18 fix actions (elenafuengar) |
169 | | -* 2024-12-18 update troubleshooting (elenafuengar) |
170 | | -* 2024-12-09 adding static methods for wake to impedance conversion and viceversa (ELENA DE LA FUENTE) |
171 | | -* 2024-12-06 Merge pull request #4 from ImpedanCEI/MaltheRaschke-patch-1 (Elena de la Fuente García) |
172 | | -* 2024-12-03 (origin/MaltheRaschke-patch-1) Small code comment correction (MaltheRaschke) |
173 | | -* 2024-11-22 improve description (elenafuengar) |
174 | | -* 2024-11-22 support matplotlib **kwargs (elenafuengar) |
175 | | -* 2024-11-22 add python notebook examples (elenafuengar) |
176 | | -* 2024-11-22 add notebook troubleshooting (elenafuengar) |
177 | | -* 2024-11-20 Update index.md (Elena de la Fuente García) |
178 | | -* 2024-10-23 add GPU setup instructions (elenafuengar) |
179 | | -* 2024-10-22 update docstring plot1D (elenafuengar) |
180 | | -* 2024-10-22 fix bugs in WavePaket + time plot feature (elenafuengar) |
181 | | -* 2024-10-22 minor changes (elenafuengar) |
182 | | -* 2024-10-22 numpy version (elenafuengar) |
183 | | -* 2024-10-05 setup manual github action (elenafuengar) |
184 | | -* 2024-10-03 Add lines of code! in green (Elena de la Fuente García) |
185 | | -* 2024-10-03 Add lines of code! (Elena de la Fuente García) |
186 | | -* 2024-10-03 Add lines of code! (Elena de la Fuente García) |
187 | | -* 2024-10-03 Update manual_tests_CPU.yml (Elena de la Fuente García) |
188 | | -* 2024-10-03 Create manual_tests_CPU.yml (Elena de la Fuente García) |
189 | | -* 2024-10-03 Create manual.yml (Elena de la Fuente García) |
190 | | -* 2024-09-30 Update index.md (Elena de la Fuente García) |
191 | | -* 2024-09-28 adding 3d plot (elenafuengar) |
192 | | -* 2024-09-26 new feautures in plot3DonSTL: field on plane capabilities (elenafuengar) |
193 | | -* 2024-09-26 bugfix in plot2D: use patch_reverse flag when a list of stl patches is passed (elenafuengar) |
194 | | -* 2024-09-26 bigfix: injection time in Beam source + add beta to speed (elenafuengar) |
195 | | -* 2024-09-26 add clip_box option to plot3DonSTL (elenafuengar) |
196 | | -* 2024-09-26 fix typo in verbose (elenafuengar) |
197 | | -* 2024-09-25 Merge branch 'main' of github.com:ImpedanCEI/wakis into main (elenafuengar) |
198 | | -* 2024-09-25 update version to match pyPI (elenafuengar) |
199 | | -* 2024-09-24 add license badge (Elena de la Fuente García) |
200 | | -* 2024-09-24 add pypi badge (Elena de la Fuente García) |
201 | | -* 2024-09-24 Update README.md (Elena de la Fuente García) |
202 | | -* 2024-09-24 Update README.md (Elena de la Fuente García) |
0 commit comments