devsim 2.12.0__cp315-abi3t-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. devsim/__init__.py +33 -0
  2. devsim/__init__.pyi +2155 -0
  3. devsim/devsim_py3.pyd +0 -0
  4. devsim/python_packages/Klaassen.py +336 -0
  5. devsim/python_packages/__init__.py +0 -0
  6. devsim/python_packages/fermi_physics.py +31 -0
  7. devsim/python_packages/model_create.py +261 -0
  8. devsim/python_packages/mos_physics.py +170 -0
  9. devsim/python_packages/pythonmesh.py +131 -0
  10. devsim/python_packages/ramp.py +101 -0
  11. devsim/python_packages/simple_dd.py +75 -0
  12. devsim/python_packages/simple_physics.py +463 -0
  13. devsim/umfpack/umfpack_lgpl.dll +0 -0
  14. devsim/umfpack/umfpack_loader.py +538 -0
  15. devsim/umfpack/umfshim.py +115 -0
  16. devsim-2.12.0.data/data/devsim_data/BUILD.md +135 -0
  17. devsim-2.12.0.data/data/devsim_data/CHANGES.md +935 -0
  18. devsim-2.12.0.data/data/devsim_data/CITATION.cff +33 -0
  19. devsim-2.12.0.data/data/devsim_data/CITATION.md +23 -0
  20. devsim-2.12.0.data/data/devsim_data/CODE_OF_CONDUCT.md +74 -0
  21. devsim-2.12.0.data/data/devsim_data/CONTRIBUTING.md +43 -0
  22. devsim-2.12.0.data/data/devsim_data/HOWTO.md +25 -0
  23. devsim-2.12.0.data/data/devsim_data/INSTALL.md +84 -0
  24. devsim-2.12.0.data/data/devsim_data/LICENSE +202 -0
  25. devsim-2.12.0.data/data/devsim_data/NOTICE +241 -0
  26. devsim-2.12.0.data/data/devsim_data/README.md +99 -0
  27. devsim-2.12.0.data/data/devsim_data/TEST.md +13 -0
  28. devsim-2.12.0.data/data/devsim_data/VERSION +3 -0
  29. devsim-2.12.0.data/data/devsim_data/doc/devsim.pdf +0 -0
  30. devsim-2.12.0.data/data/devsim_data/doc/symdiff.pdf +0 -0
  31. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/Ve0.jpg +0 -0
  32. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/Ve0_3d.jpg +0 -0
  33. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/Ve7.jpg +0 -0
  34. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/Ve7_3d.jpg +0 -0
  35. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/bioapp1_2d.py +85 -0
  36. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/bioapp1_3d.py +85 -0
  37. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/bioapp1_common.py +399 -0
  38. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/disk_2d.geo +62 -0
  39. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/disk_2d.msh +65606 -0
  40. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/disk_3d.geo +183 -0
  41. devsim-2.12.0.data/data/devsim_data/examples/bioapp1/disk_3d.msh +25808 -0
  42. devsim-2.12.0.data/data/devsim_data/examples/capacitance/cap.lay +1587 -0
  43. devsim-2.12.0.data/data/devsim_data/examples/capacitance/cap1d.py +155 -0
  44. devsim-2.12.0.data/data/devsim_data/examples/capacitance/cap2d.py +200 -0
  45. devsim-2.12.0.data/data/devsim_data/examples/diode/3dblock.geo +48 -0
  46. devsim-2.12.0.data/data/devsim_data/examples/diode/diode_1d.py +94 -0
  47. devsim-2.12.0.data/data/devsim_data/examples/diode/diode_1d_custom.py +159 -0
  48. devsim-2.12.0.data/data/devsim_data/examples/diode/diode_2d.py +68 -0
  49. devsim-2.12.0.data/data/devsim_data/examples/diode/diode_common.py +253 -0
  50. devsim-2.12.0.data/data/devsim_data/examples/diode/diode_current.lay +3271 -0
  51. devsim-2.12.0.data/data/devsim_data/examples/diode/diode_density.lay +3271 -0
  52. devsim-2.12.0.data/data/devsim_data/examples/diode/diode_potential.lay +3272 -0
  53. devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode2d.msh +1477 -0
  54. devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode2d.py +55 -0
  55. devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode3d.msh +8557 -0
  56. devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode3d.py +74 -0
  57. devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode3d_equil.py +43 -0
  58. devsim-2.12.0.data/data/devsim_data/examples/diode/gmsh_diode3d_float128.py +85 -0
  59. devsim-2.12.0.data/data/devsim_data/examples/diode/laux2d.py +43 -0
  60. devsim-2.12.0.data/data/devsim_data/examples/diode/laux3d.py +54 -0
  61. devsim-2.12.0.data/data/devsim_data/examples/diode/laux_common.py +503 -0
  62. devsim-2.12.0.data/data/devsim_data/examples/diode/pythonmesh3d.py +61 -0
  63. devsim-2.12.0.data/data/devsim_data/examples/diode/ssac_diode.py +57 -0
  64. devsim-2.12.0.data/data/devsim_data/examples/diode/tran_diode.py +63 -0
  65. devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d.geo +160 -0
  66. devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d.msh +8599 -0
  67. devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d.py +96 -0
  68. devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d_create.py +174 -0
  69. devsim-2.12.0.data/data/devsim_data/examples/mobility/gmsh_mos2d_kla.py +162 -0
  70. devsim-2.12.0.data/data/devsim_data/examples/mobility/logElectrons.lay +1327 -0
  71. devsim-2.12.0.data/data/devsim_data/examples/mobility/pythonmesh2d.py +100 -0
  72. devsim-2.12.0.data/data/devsim_data/examples/mobility/test.lay +3385 -0
  73. devsim-2.12.0.data/data/devsim_data/examples/mobility/times.txt +34 -0
  74. devsim-2.12.0.data/data/devsim_data/examples/plotting/visualization.ipynb +160 -0
  75. devsim-2.12.0.data/data/devsim_data/examples/vectorpotential/twowire.geo +34 -0
  76. devsim-2.12.0.data/data/devsim_data/examples/vectorpotential/twowire.lay +1469 -0
  77. devsim-2.12.0.data/data/devsim_data/examples/vectorpotential/twowire.msh +13596 -0
  78. devsim-2.12.0.data/data/devsim_data/examples/vectorpotential/twowire.py +177 -0
  79. devsim-2.12.0.data/data/devsim_data/pyproject.toml +33 -0
  80. devsim-2.12.0.data/data/devsim_data/setup.py +64 -0
  81. devsim-2.12.0.data/data/devsim_data/testing/3dtetmesh.msh +281 -0
  82. devsim-2.12.0.data/data/devsim_data/testing/CMakeLists.txt +174 -0
  83. devsim-2.12.0.data/data/devsim_data/testing/Fermi1.py +59 -0
  84. devsim-2.12.0.data/data/devsim_data/testing/Fermi1_float128.py +18 -0
  85. devsim-2.12.0.data/data/devsim_data/testing/GaussFermi.py +38 -0
  86. devsim-2.12.0.data/data/devsim_data/testing/GaussFermi_float128.py +18 -0
  87. devsim-2.12.0.data/data/devsim_data/testing/cap2.py +439 -0
  88. devsim-2.12.0.data/data/devsim_data/testing/cap_mesh.py +33 -0
  89. devsim-2.12.0.data/data/devsim_data/testing/circ1.py +79 -0
  90. devsim-2.12.0.data/data/devsim_data/testing/circ2.py +79 -0
  91. devsim-2.12.0.data/data/devsim_data/testing/circ3.py +18 -0
  92. devsim-2.12.0.data/data/devsim_data/testing/circ4.py +105 -0
  93. devsim-2.12.0.data/data/devsim_data/testing/dio2_element_2d.py +136 -0
  94. devsim-2.12.0.data/data/devsim_data/testing/dio2_element_physics.py +302 -0
  95. devsim-2.12.0.data/data/devsim_data/testing/equation1.py +68 -0
  96. devsim-2.12.0.data/data/devsim_data/testing/erf1.py +52 -0
  97. devsim-2.12.0.data/data/devsim_data/testing/erf2.py +34 -0
  98. devsim-2.12.0.data/data/devsim_data/testing/fpetest1.py +21 -0
  99. devsim-2.12.0.data/data/devsim_data/testing/fpetest2.py +25 -0
  100. devsim-2.12.0.data/data/devsim_data/testing/gmsh_mos3d.geo +272 -0
  101. devsim-2.12.0.data/data/devsim_data/testing/info.py +15 -0
  102. devsim-2.12.0.data/data/devsim_data/testing/kahan.py +24 -0
  103. devsim-2.12.0.data/data/devsim_data/testing/kahan_float128.py +18 -0
  104. devsim-2.12.0.data/data/devsim_data/testing/laux1.py +232 -0
  105. devsim-2.12.0.data/data/devsim_data/testing/mctest.mc +30 -0
  106. devsim-2.12.0.data/data/devsim_data/testing/mctest_user.mc +33 -0
  107. devsim-2.12.0.data/data/devsim_data/testing/mesh1.msh +52 -0
  108. devsim-2.12.0.data/data/devsim_data/testing/mesh1.py +121 -0
  109. devsim-2.12.0.data/data/devsim_data/testing/mesh2.msh +70 -0
  110. devsim-2.12.0.data/data/devsim_data/testing/mesh2.py +210 -0
  111. devsim-2.12.0.data/data/devsim_data/testing/mesh2d.py +105 -0
  112. devsim-2.12.0.data/data/devsim_data/testing/mesh3.py +8 -0
  113. devsim-2.12.0.data/data/devsim_data/testing/mesh4.py +8 -0
  114. devsim-2.12.0.data/data/devsim_data/testing/mos_2d.py +111 -0
  115. devsim-2.12.0.data/data/devsim_data/testing/mos_2d_create.py +207 -0
  116. devsim-2.12.0.data/data/devsim_data/testing/mos_2d_restart.py +69 -0
  117. devsim-2.12.0.data/data/devsim_data/testing/mos_2d_restart2.py +24 -0
  118. devsim-2.12.0.data/data/devsim_data/testing/noise_res.py +51 -0
  119. devsim-2.12.0.data/data/devsim_data/testing/noise_res_2d.py +101 -0
  120. devsim-2.12.0.data/data/devsim_data/testing/other_blas.py +28 -0
  121. devsim-2.12.0.data/data/devsim_data/testing/ptest1.py +53 -0
  122. devsim-2.12.0.data/data/devsim_data/testing/ptest2.py +110 -0
  123. devsim-2.12.0.data/data/devsim_data/testing/pythonmesh1d.py +202 -0
  124. devsim-2.12.0.data/data/devsim_data/testing/res1.py +65 -0
  125. devsim-2.12.0.data/data/devsim_data/testing/res2.py +65 -0
  126. devsim-2.12.0.data/data/devsim_data/testing/res3.py +59 -0
  127. devsim-2.12.0.data/data/devsim_data/testing/rundifftest.py +62 -0
  128. devsim-2.12.0.data/data/devsim_data/testing/ssac_cap.py +145 -0
  129. devsim-2.12.0.data/data/devsim_data/testing/ssac_cap_2d_edge.py +199 -0
  130. devsim-2.12.0.data/data/devsim_data/testing/ssac_cap_2d_element.py +214 -0
  131. devsim-2.12.0.data/data/devsim_data/testing/ssac_cap_3d_edge.py +148 -0
  132. devsim-2.12.0.data/data/devsim_data/testing/ssac_cap_3d_element.py +167 -0
  133. devsim-2.12.0.data/data/devsim_data/testing/ssac_circ.py +18 -0
  134. devsim-2.12.0.data/data/devsim_data/testing/ssac_res.py +30 -0
  135. devsim-2.12.0.data/data/devsim_data/testing/symdiff1.py +54 -0
  136. devsim-2.12.0.data/data/devsim_data/testing/test_common.py +435 -0
  137. devsim-2.12.0.data/data/devsim_data/testing/testfunc.py +65 -0
  138. devsim-2.12.0.data/data/devsim_data/testing/testfunc_extended.py +8 -0
  139. devsim-2.12.0.data/data/devsim_data/testing/transient_circ.py +67 -0
  140. devsim-2.12.0.data/data/devsim_data/testing/transient_circ2.py +67 -0
  141. devsim-2.12.0.data/data/devsim_data/testing/transient_circ3.py +125 -0
  142. devsim-2.12.0.data/data/devsim_data/testing/transient_rc.py +157 -0
  143. devsim-2.12.0.data/data/devsim_data/testing/trimesh1.msh +47 -0
  144. devsim-2.12.0.data/data/devsim_data/testing/trimesh1.py +114 -0
  145. devsim-2.12.0.data/data/devsim_data/testing/trimesh2.py +114 -0
  146. devsim-2.12.0.data/data/devsim_data/testing/utf8_2.py +126 -0
  147. devsim-2.12.0.dist-info/METADATA +122 -0
  148. devsim-2.12.0.dist-info/RECORD +152 -0
  149. devsim-2.12.0.dist-info/WHEEL +5 -0
  150. devsim-2.12.0.dist-info/licenses/LICENSE +202 -0
  151. devsim-2.12.0.dist-info/licenses/NOTICE +241 -0
  152. devsim-2.12.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,935 @@
1
+
2
+ # CHANGES
3
+
4
+ ## Introduction
5
+
6
+ Please see the release notes in `doc/devsim.pdf` or at [https://devsim.net](https://devsim.net) for more detailed information about changes.
7
+
8
+ ## Version 2.12.0
9
+
10
+ ### Free-Threaded Python Support
11
+
12
+ * [#173](https://github.com/devsim/devsim/issues/173) python threaded version
13
+
14
+ Support for free-threaded Python 3.15t and higher has been added. This allows DEVSIM to run with the Python GIL disabled. The release scripts now build separate `cp39-abi3` and `cp315-abi3t` wheels for each platform.
15
+
16
+ ### Thread Safety
17
+
18
+ * [#177](https://github.com/devsim/devsim/issues/177) thread safety
19
+
20
+ A recursive mutex has been added to the dispatch function in the Python API to serialize module function calls. Concurrent calls from different threads will raise a `RuntimeError` with the message "Multithreaded calls to the devsim module functions are not supported". Recursive calls from the same thread are allowed, supporting use cases where internal module code calls devsim public functions. This approach prevents deadlocks while ensuring safe operation in free-threaded Python environments.
21
+
22
+ ### Packaging Changes
23
+
24
+ * [#174](https://github.com/devsim/devsim/issues/174) move to pyproject.toml
25
+
26
+ The wheel packaging configuration has been migrated from `setup.py` to `pyproject.toml` for both the regular and free-threaded variants. This modernizes the packaging approach and improves compatibility with current Python tooling. The build metadata and versioning are now centralized in the project configuration file.
27
+
28
+ ### File Organization
29
+
30
+ * [#175](https://github.com/devsim/devsim/issues/175) file reorganization
31
+
32
+ The source tree has been reorganized to improve maintainability. Documentation, examples, and wheel staging directories have been restructured. This change consolidates related files and improves the overall project structure without affecting functionality.
33
+
34
+ ### Windows Python Support
35
+
36
+ * [#176](https://github.com/devsim/devsim/issues/176) use other Python on windows
37
+
38
+ The Windows build process has been updated to support alternative Python installations beyond Anaconda Python. Please see [BUILD.md](BUILD.md) for more information.
39
+
40
+ ## Version 2.11.2
41
+
42
+ ### Trusted Publishing
43
+
44
+ * [#170](https://github.com/devsim/devsim/issues/170) add trusted publishing to pypi
45
+
46
+ Python wheels are now published directly from GitHub Actions to PyPI. This makes the released files more secure in the their handling. Tools are available to verify the provenance. More info is available from [https://docs.pypi.org/trusted-publishers/](https://docs.pypi.org/trusted-publishers/).
47
+
48
+ ### Citing DEVSIM
49
+
50
+ * [CITATION.cff](CITATION.cff) with suggested citations for the simulator. It also contains some additional references.
51
+
52
+ ### Resetting DEVSIM while using umfpack
53
+
54
+ * [#169](https://github.com/devsim/devsim/issues/169) umfpack reload after `devsim_reset`
55
+
56
+ When using the `reset_devsim` command to reset the simulator, the `UMFPACK 5.1` solver was not being reloaded. The command is modified so that the solver will now continue to with the same `BLAS` library when `devsim` is first loaded.
57
+
58
+ Internally, the `UMFPACK 5.1` hook in devsim will no longer reload the `BLAS` library with each call to the `solve` command. In addition, the math libraries used by `devsim` will only be loaded when the module is first imported.
59
+
60
+ ### pylance compatible docstrings
61
+
62
+ * [#155](https://github.com/devsim/devsim/issues/155) pylance compatible docstrings
63
+
64
+ A `__init__.pyi` file is included in `devsim` to provide documentation in IDEs which cannot get them from the compiled shared libraries. This file should be automatically detected and used within the IDE. It is generated in the `devsim/devsim_documenation` project.
65
+
66
+ ### misc changes
67
+
68
+ The `symdiff` manual and example files are no longer included in the distribution. These files can be downloaded by installing `symdiff` via `pip`.
69
+
70
+ An extra copy of the `umfpack_lgpl` dynamic library was being distributed in the `macOS` package and has been removed.
71
+
72
+ ## Version 2.11.1
73
+
74
+ ### Math Library Support
75
+
76
+ #### BLAS Symbol Naming
77
+
78
+ * [#167](https://github.com/devsim/devsim/issues/167) Accept scipy-openblas32 as a BLAS/LAPACK provider
79
+
80
+ When `DEVSIM_MATH_LIBS` is set, a user may specify `DEVSIM_BLAS_PREFIX` and `DEVSIM_BLAS_SUFFIX` to math symbols not using the standard form.
81
+
82
+ ```
83
+ import scipy_openblas32
84
+ import os
85
+ os.environ['DEVSIM_MATH_LIBS'] = os.path.join(scipy_openblas32.get_lib_dir(), 'libscipy_openblas.dylib')
86
+ os.environ['DEVSIM_BLAS_PREFIX'] = 'scipy_'
87
+ os.environ['DEVSIM_BLAS_SUFFIX'] = '_'
88
+ import devsim
89
+ ```
90
+
91
+ Please see `testing/other_blas.py` for an example using the `scipy_openblas32` package as an alternative to the default math packages on each system. This example is fragile as the math package maintainers make no guarantess for a stable abi.
92
+
93
+ Thanks to [@benvial](https://github.com/benvial) for suggesting this feature.
94
+
95
+ #### Info strings with more math informaiton
96
+
97
+ As part of this work, more information is returned via the `info` parameter:
98
+
99
+ ```
100
+ >>> _ = [print(x) for x in devsim.get_parameter(name="info").items()]
101
+ ('blas_symbol_prefix', 'scipy_')
102
+ ('blas_symbol_suffix', '_')
103
+ ('copyright', 'Copyright © 2009-2026 DEVSIM LLC')
104
+ ('direct_solver', 'custom')
105
+ ('extended_precision', True)
106
+ ('license', 'Apache License, Version 2.0')
107
+ ('math_libraries', ('/Users/user/git/venv/lib/python3.14/site-packages/scipy_openblas32/lib/libscipy_openblas.dylib',))
108
+ ('version', '2.11.1')
109
+ ('website', 'https://devsim.org')
110
+ ('custom_solver', 'UMFPACK 5.1')
111
+ ```
112
+
113
+ ### Platform Support
114
+
115
+ #### macOS
116
+
117
+ Due to the deprecation of the macOS 14 image on GitHub Actions, the software is now built on macOS 15 Sequoia.
118
+
119
+ #### Windows
120
+
121
+ Due to changes to the file location of shared libraries and include files in Anaconda Python, the automated build has been updated.
122
+
123
+ ### Bugs
124
+
125
+ #### Helper function for model creation bug
126
+
127
+ * [#168](https://github.com/devsim/devsim/issues/168) `model_create.EnsureEdgeFromNodeModelExists` never creates the `X@n0/X@n1` edge models
128
+
129
+ Thanks to [@NooriDan](https://github.com/NooriDan) for reporting this issue.
130
+
131
+
132
+ ## Version 2.11.0
133
+
134
+ ### Surface Normal Models
135
+
136
+ * [#162](https://github.com/devsim/devsim/issues/162) surface normal models should point outward
137
+
138
+ The following node models now point outward for each node. Previously, the sign was arbitrary.
139
+
140
+ * `ContactNSurfaceNormal_x`
141
+ * `ContactNSurfaceNormal_y`
142
+ * `ContactNSurfaceNormal_z`
143
+ * `NSurfaceNormal_x`
144
+ * `NSurfaceNormal_y`
145
+ * `NSurfaceNormal_z`
146
+
147
+ The only regression results affected were the saved values for the values at some nodes changed direction based on how they were averaged to the node.
148
+
149
+ ### GitHub Issues
150
+
151
+ * [#165](https://github.com/devsim/devsim/issues/165) Update c++20
152
+ * [#164](https://github.com/devsim/devsim/issues/164) use std array for basic shapes
153
+ * [#160](https://github.com/devsim/devsim/issues/160) Visual Studio 2026
154
+
155
+ ## Version 2.10.1
156
+
157
+ ### UMFPACK Solver
158
+
159
+ Fixed issue with `UMFPACK` solver when the dynamic library is being unloaded at program termination.
160
+
161
+ ### Windows MKL
162
+
163
+ Fix issue [#159](https://github.com/devsim/devsim/issues/159) where users had to add `Library\bin` manually to the system path in order to load the Intel MKL when using a non Anaconda-based Python distribution. The proper way to install the Intel MKL using `pip` is:
164
+
165
+ ```
166
+ pip install mkl
167
+ ```
168
+
169
+ Thanks to [@JoonatanAlanampa](https://github.com/JoonatanAlanampa) for helping to diagnose this issue.
170
+
171
+ ## Version 2.10.0
172
+
173
+ ### Regression results
174
+
175
+ Due to the changes in this release, there are changes to the expected numerical results.
176
+
177
+ ### Available platform builds.
178
+
179
+ Build automation is now being done using GitHub Actions. This has lead to the following changes to the build:
180
+
181
+ #### macOS
182
+
183
+ Intel `x86_64` is no longer longer a supported on `macOS`. The minimum supported version is now 14.7.6 Sonoma. Regression results are updated:
184
+ * [devsim_tests_macos_arm64](https://github.com/devsim/devsim_tests_macos_arm64)
185
+
186
+ #### Windows
187
+
188
+ Now built on Windows 2025 server running the latest supported version of Visual Studio 2022 Enterprise.
189
+
190
+ #### Linux
191
+
192
+ Linux continues to be built on the `manylinux_2_28` docker image. This is compatible with AlmaLinux 8 and is expected to be binary compatible with most current linux distributions for both `x86_64` and `aarch64`.
193
+
194
+ ### Python Version
195
+
196
+ Python 3.9 is now the minimum supported version. Please make sure you are using a newer version of Python when attempting to download from PyPi. Python 3.9 is end of life on October 31, 2025, and we may switch to Python 3.10 as the minimum supported version after that.
197
+
198
+ ### Contact Normal Model
199
+
200
+ Fix issue [#158](https://github.com/devsim/devsim/issues/158), Missing Contact Surface Normal
201
+ `ContactNSurfaceNormal_x`
202
+ `ContactNSurfaceNormal_y`
203
+ `ContactNSurfaceNormal_z`
204
+
205
+ Thanks to [@marc-flex](https://github.com/marc-flex) for providing a pull request for these missing models.
206
+
207
+ ### Documentation
208
+
209
+ A tasks note is added in `HOWTO.md`.
210
+
211
+ ## Version 2.9.1
212
+
213
+ ### C++ Code Cleanup
214
+
215
+ Internal code was refactored. While it has been tested, please report any issues you may encounter.
216
+
217
+ ## Version 2.9.0
218
+
219
+ ### Windows Python support
220
+
221
+ The official `python.org` distribution is better supported. This is since the `python.org` distribution does not appear to ship the `zlib.dll`.
222
+
223
+ ### VTK writer
224
+
225
+ [#151](https://github.com/devsim/devsim/issues/151)
226
+
227
+ Use `zlib` from Python module instead of Anaconda `zlib.dll` or the system `zlib` for other operating systems. The compressed binary data written to the `.vtu` files should be numerically the same.
228
+
229
+ ### Clang build on Windows
230
+
231
+ While the Windows version is still built with Visual Studio 2022, the build system now supports building with the Clang compilers.
232
+
233
+ ## Version 2.8.4
234
+
235
+ ### Serialization of equation command
236
+
237
+ Write `variable_update` when writing the `equation` command to the devsim file format.
238
+
239
+ ### Simulation Matrix
240
+
241
+ Fix issue [#148](https://github.com/devsim/devsim/issues/148) segmentation fault in `get_matrix_and_rhs`. Matrix and RHS now printed in `testing/cap2.py`.
242
+
243
+ ### macOS Build
244
+
245
+ Fix issue [#149](https://github.com/devsim/devsim/issues/149) fix issue with macOS build scripts.
246
+
247
+ ## Version 2.8.3
248
+
249
+ ### Linux support
250
+
251
+ Due to the Red Hat 7 end of life on June 30, 2024, the minimum support level for Linux is now Red Hat 8 using the AlmaLinux 8 based [manylinux_2_28](https://github.com/pypa/manylinux?tab=readme-ov-file#manylinux_2_28-almalinux-8-based).
252
+
253
+ ### Clang format
254
+
255
+ Add `.clang-format` file to provide assist automatic formatting for new source code.
256
+
257
+ ### Get equation command
258
+
259
+ Fixed issue [#145](https://github.com/devsim/devsim/issues/145). `get_equation_command` now provides the `variable_update` option that was used.
260
+
261
+ ### Exception propagation
262
+
263
+ Fixed issue where an internal C++ based exception, may not be caught properly on some platforms.
264
+
265
+ ## Version 2.8.2
266
+
267
+ ### Documentation updates
268
+
269
+ The documentation has undergone major updates. Please see it at `doc/devsim.pdf` and online at [https://devsim.net](https://devsim.net).
270
+
271
+ ## Version 2.8.1
272
+
273
+ ### Help Files
274
+
275
+ Updated instructions. Added additional documentation files.
276
+
277
+ | File | Purpose |
278
+ | --- | --- |
279
+ | [BUILD.md](BUILD.md) | Building from source |
280
+ | [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) | Code of conduct |
281
+ | [TEST.md](TEST.md) | Testing instructions |
282
+
283
+ and removed [install.py](install.py).
284
+
285
+ ### Database Command Removal
286
+
287
+ Remove commands:
288
+
289
+ * `create_db`
290
+ * `open_db`
291
+ * `close_db`
292
+ * `save_db`
293
+ * `add_db_entry`
294
+ * `get_db_entry`
295
+
296
+ This feature was only being used in the `bioapp1` examples, and those tests have been updated. This also removes the binary dependence on SQLite.
297
+
298
+ ## Version 2.8.0
299
+
300
+ ### Python Scripts
301
+
302
+ Based on a contribution by [@simbilod](https://github.com/simbilod), all of the Python scripts have been reformatted. The build system was also updated to enforce Python script modifications are properly formatted when submitted to the project.
303
+
304
+ ### Data output
305
+
306
+ #### Reduction in Data File Sizes
307
+
308
+ Based on a contribution by [@simbilod](https://github.com/simbilod) `devsim.write_devices` now supports reducing the file size of data files by specifying a callback function to reduce data usage. This is through the `include_test` option. This option is a function that takes a string and returns `True` if the model should be written. It is only supported for the `tecplot` and `vtk` formats.
309
+
310
+ In this example, only the `NetDoping` field is written to the Tecplot data file.
311
+
312
+ ```
313
+ devsim.write_devices(
314
+ file="mesh2d_reduced.tec",
315
+ type="tecplot",
316
+ include_test=lambda x: x in ("NetDoping",),
317
+ )
318
+ ```
319
+
320
+
321
+ #### FLOOPS Data File Output
322
+
323
+ The `floops` option for `devsim.write_devices` has been removed.
324
+
325
+
326
+ ### Platform Support
327
+
328
+ ### Windows Build Issue
329
+
330
+ During testing, it was found the Visual Studio 2022 builds were failing a test related to threading. This was found to be a problem with version `17.10`, but not version `17.9`. This affects the build automation, but should not affect the binary releases.
331
+
332
+ ### Centos 7 End of Life
333
+
334
+ This is the last version to support Centos 7 before its end of life on June 30, 2024. After this date we will be moving to the AlmaLinux 8 based `manylinux_2_28`.
335
+
336
+ ## Version 2.7.3
337
+
338
+ Fixed issue [#133](https://github.com/devsim/devsim/issues/133) identified by [@yh-kwok](https://github.com/yh-kwok).
339
+
340
+ ## Version 2.7.2
341
+
342
+ * macOS package is now Universal. Both `x86_64` and `arm64` will use `clang` compiler and macOS 12.0 is now the minimum supported version.
343
+ * Update Boost version to 1.82
344
+ * Improvements to extended precision complex numbers implementation to work with newer compilers.
345
+ * Script to build for `manylinux_2_28` (Centos 8)
346
+ * Build Linux aarch64 from macOS system with docker
347
+
348
+ ## Version 2.7.1
349
+
350
+ * Support for Linux aarch64, which can be run on Amazon AWS 64 bit instances.
351
+ * Better implicit float conversions in parameters.
352
+
353
+ ## Version 2.7.0
354
+
355
+ More helpful exception information returned to python if the error is considered fatal.
356
+
357
+ ## Version 2.6.5
358
+
359
+ ### Bugs
360
+
361
+ Fixed issue [#123](https://github.com/devsim/devsim/issues/123) identified by [@gluek](https://github.com/gluek). This resulted in bad results on Windows and macOS in calculation of 3d mesh areas and volumes.
362
+
363
+ ## Version 2.6.4
364
+
365
+ Use `MMD_ATA` preconditioner for SuperLU builds.
366
+
367
+ Android builds use special implementations for the Bernoulli function to prevent overflow.
368
+
369
+ `testing/pythonmesh1d.py` demonstrates how to get mesh information using `devsim.get_element_node_list`.
370
+
371
+ `examples/diode/tran_diode.py` demonstrates transient diode simulation.
372
+
373
+ ## Version 2.6.3
374
+
375
+ Allow python threading during long solve operations.
376
+
377
+ ## Version 2.6.2
378
+
379
+ `delete_circuit`
380
+
381
+ `get_mesh_list`
382
+
383
+ ## Version 2.6.1
384
+
385
+ ### Bugs
386
+
387
+ Fix issue [#116](https://github.com/devsim/devsim/issues/116) where the contact current was being calculated incorrectly in transient mode.
388
+
389
+ ## Version 2.6.0
390
+
391
+ ### Symbolic Factorization Reuse
392
+
393
+ The Intel MKL solver will now use reuse the symbolic factorization, if the simulation matrix sparse matrix pattern has not changed after the second nonlinear solver iteration. This reduces simulation time, but can result in numerical differences in the simulation result. Setting the environment variable, `DEVSIM_NEW_SYMBOLIC`, will do a new symbolic factorization for each iteration.
394
+
395
+ This behavior may be controlled by using this option in the solve command
396
+ ```
397
+ solve(symbolic_iteration_limit = -1)
398
+ ```
399
+ where setting the value to `-1` will create a new symbolic factorization for all nonlinear iterations. Setting the value to a number greater than `0` will mark all iterations afterwards for reusing the previous symbolic factorization.
400
+
401
+ ### Reset Simulator
402
+
403
+ The `reset_devsim` command will clear all simulator data, so that a program restart is not necessary.
404
+
405
+ ### Build Infrastructure
406
+
407
+ #### LAPACK is Optional
408
+
409
+ When LAPACK functions are not available, it is now possible to use Eigen instead. BLAS is still required. It is up to the direct solver being used to determine necessary LAPACK functions.
410
+
411
+ #### Self Contained Build
412
+
413
+ The build infrastructure is being updated to support a small application build on different systems. For these builds, some commands are removed and SuperLU is the only available solver.
414
+
415
+ #### SuperLU Solver
416
+
417
+ For self contained builds, some commands are removed and SuperLU is the only available solver.
418
+
419
+ ### Citing DEVSIM
420
+
421
+ [CITATION.md](CITATION.md) has been updated with recent articles written about the simulator.
422
+
423
+ ## Version 2.5.0
424
+
425
+ UMFPACK 5.1 is the new default when the Intel MKL is not available, making this the default for the macOS arm64 platform.
426
+
427
+ SuperLU is removed and no longer available as a solver.
428
+
429
+ Regression scripts were passing when there were numerical differences in the data diff comparison. This is now corrected and the regression results have been updated on all platforms.
430
+
431
+ For those building the software, the `EXPLICIT_MATH_LOAD` CMAKE option has been removed, so that the software is not directly linked to any math library.
432
+
433
+ The license text for the Apache 2.0 license has been replaced with the SPDX format of the license string. This ensures that the text can be used in a consistent manner across all source files.
434
+
435
+ ## Version 2.4.0
436
+
437
+ ### Determine Loaded Math Libraries
438
+
439
+ To determine the loaded math libraries, use
440
+ ```
441
+ devsim.get_parameter(name='info')['math_libraries']
442
+ ```
443
+
444
+ ### UMFPACK 5.1 Solver
445
+
446
+ The `UMFPACK` 5.1 solver is now available as a shared library distributed with the software. It is licensed under the terms of the LGPL 2.1 and our version is hosted here:
447
+
448
+ [https://github.com/devsim/umfpack_lgpl](https://github.com/devsim/umfpack_lgpl)
449
+
450
+ Please note that this version uses a scheme to provide the needed math library functions when the library is loaded.
451
+
452
+ In order to use this library, a shim script is provided to load UMFPACK and set it as the solver. Please see this example:
453
+ ```
454
+ python -mdevsim.umfpack.umfshim ssac_cap.py
455
+ ```
456
+
457
+ ### Direct Solver Callback
458
+
459
+ It is now possible to setup call a custom direct solver. The direct solver is called from Python and the callback is implemented by setting these parameters:
460
+ ```
461
+ devsim.set_parameter(name="direct_solver", value="custom")
462
+ devsim.set_parameter(name="solver_callback", value=local_solver_callback)
463
+ ```
464
+
465
+ Where the first parameter enables the use of the second parameter to set a callback function. Please see the `testing/umfpack_shim.py` for a sample implementation using UMFPACK 5.1.
466
+
467
+ ### Apple M1
468
+
469
+ On this platform, the software does not check for floating point exceptions (FPEs) during usage of the direct solver. During testing, it was discovered that FPEs were occuring during factorization for both the `SuperLU` and the `UMFPACK`. Removing this check allows more of the tests to run through to completion.
470
+
471
+ ### Bugs
472
+
473
+ Fix issue [#104](https://github.com/devsim/devsim/issues/104) where the 2D MOSFET example was not fully connected across region interfaces.
474
+ ```
475
+ testing/mos_2d.py
476
+ testing/mos_2d_restart.py
477
+ testing/mos_2d_restart2.py
478
+ ```
479
+ This was resulting in an FPE during testing on macOS M1.
480
+
481
+ ## Version 2.3.8
482
+
483
+ ### Bugs
484
+
485
+ [@ryan3141](https://github.com/ryan3141) fixed an issue where math functions added with `devsim.register_function` were not available in extended precision model evaluation. The `testing/testfunc_extended.py` test is added to validate the fix.
486
+
487
+ Update NOTICE with the license files from the various dependencies.
488
+
489
+ ## Version 2.3.7
490
+
491
+ ### Apple M1 Support
492
+
493
+ Intel MKL Pardiso not available, so using system BLAS/LAPACK or openblas by default. In addition, SuperLU, is used instead of the MKL Pardiso. This results in some test failures, based on the use of a different solver, and not the OS architecture.
494
+
495
+ Extended precision is enabled.
496
+
497
+ Enabled by running pip install.
498
+
499
+ The regression results are in this newly created repo:
500
+
501
+ * [devsim_tests_macos_arm64](https://github.com/devsim/devsim_tests_macos_arm64)
502
+
503
+
504
+ ### Python Notebook Example With 3D Visualization
505
+
506
+
507
+ A plotting example using `pyvista` is presented in `examples/plotting/visualization.ipynb`. This example was provided by [@simbilod](https://github.com/simbilod).
508
+
509
+ ### Bugs
510
+
511
+ When instantiating a mesh from Gmsh, contact and interface related errors to dimensionality have an improved error message.
512
+
513
+
514
+ ## Version 2.3.6
515
+
516
+ On Windows the `DEVSIM_MATH_LIBS` now uses the `;` as the path separator, while macOS and Linux still use `:`.
517
+
518
+ The math library search order is then:
519
+
520
+ * The math libraries listed in the `DEVSIM_MATH_LIBS` environment variable, with the appropriate separator.
521
+ * The Intel Math Kernel Library
522
+ * These dynamic libraries
523
+ * OpenBLAS (e.g. libopenblas.so)
524
+ * LAPACK (e.g. liblapack.so)
525
+ * BLAS (e.g. libblas.so)
526
+
527
+ All platforms will search for the Intel MKL by trying several version numbers. When the Intel MKL is not available, the direct solver will switch from Intel MKL Pardiso to SuperLU.
528
+
529
+ On macOS and Linux, the RPATH has been modified to look in places relative to the `devsim` module, instead of using `CONDA_PREFIX` or `VIRTUAL_ENV`.
530
+
531
+ * `macOS` : `@loader_path;@loader_path/../lib;@loader_path/../../../../lib;@executable_path/../lib`
532
+ * `Linux` : `$ORIGIN:$ORIGIN/../lib:$ORIGIN/../../../../lib`
533
+
534
+ ## Version 2.3.1
535
+
536
+ ### Python PIP Package
537
+
538
+ DEVSIM is now available on pypi for macOS, Linux, and Microsoft Windows. To install this package for your platform:
539
+
540
+ ```
541
+ pip install devsim
542
+ ```
543
+
544
+ Users of Anaconda Python should install the Intel MKL using
545
+ ```
546
+ conda install mkl
547
+ ```
548
+
549
+ and may find simulation files and documentation in `$CONDA_PREFIX/devsim_data`.
550
+
551
+ Users of other Python distributions may install this dependency using:
552
+ ```
553
+ pip install mkl
554
+ ```
555
+
556
+ and may find simulation files and documentation in `$VIRTUAL_ENV/devsim_data` when using virtual environments.
557
+
558
+
559
+ ### Remove Windows MSYS Build
560
+
561
+ The MSYS build is removed as an available binary package. Windows is still supported through the use of the Visual C++ compiler.
562
+
563
+ ### Build Notes
564
+
565
+ The compiler for the Linux build are now upgraded to `devtoolset-10` and is now built on `manylinux2014`.
566
+
567
+ Boost is now added as a submodule, instead of using system libraries or Anaconda Python versions. The Linux build no longer requires Anaconda Python.
568
+
569
+ ## Version 2.2.0
570
+
571
+ It is possible to delete devices using the `delete_device` command. Meshes used to instantiate devices may be deleted using the `delete_mesh` command. Parameters set on a device and its regions are also cleared from the parameter database.
572
+
573
+ Extended precision is now available on Windows builds using the Visual Studio Compiler. Note that this precision is not as accurate as the float128 type used on other systems.
574
+
575
+ Upgraded to SuperLU 5.3 from SuperLU 4.3.
576
+
577
+ Fixed defects found in Coverity scanning.
578
+
579
+ ## Version 2.1.0
580
+
581
+ ### Explicit math library loading
582
+
583
+ #### Introduction
584
+
585
+ Since the Intel Math Kernel Library started versioning the names of their dynamic link libraries, it has been difficult to maintain a proper Anaconda Python environment when the version has been updated. With this release, it is possible to use any recent version of the Intel MKL. In addition, the user is able to load alternative BLAS/LAPACK math libraries.
586
+
587
+ #### Intel MKL
588
+
589
+ From DEVSIM Version 2.1.0 onward, a specific version is not required when loading the Intel MKL. If the Intel MKL is not found, the import of the `devsim` module will fail, and an error message will be printed. This method is the default, and should work when using an Anaconda Python environment with the `mkl` package installed.
590
+
591
+ When using a different Python distribution, or having an installation in a different place, it is possible to specify the location by modifying the `LD_LIBRARY_PATH` environment variable on Linux, or using `DYLD_LIBRARY_PATH` on macOS. The explicit path may be set to the MKL math libraries may be set using the method in the next section.
592
+
593
+ #### Loading other math libraries
594
+
595
+ It is possible to load alternative implementations of the BLAS/LAPACK used by the software. The `DEVSIM_MATH_LIBS` environment variable may be used to set a `:` separated list of libraries. These names may be based on relative or absolute paths. The program will load the libraries in order, and stop when all of the necessary math symbols are supplied. If symbols for the Intel MKL are detected, then the Pardiso direct solver will be enabled.
596
+
597
+ #### New CMAKE build option
598
+ For those building the software, the `EXPLICIT_MATH_LOAD` CMAKE option has been added to control the new explicit math loading feature. An important benefit of this option is that it is possible to build a release version of the software, even if the Intel MKL has not been installed on the build computer.
599
+
600
+ ### Direct solver selection
601
+
602
+ The direct solver may be selected by using the `direct_solver` parameter.
603
+ ```
604
+ devsim.set_parameter(name='direct_solver', value='mkl_pardiso')
605
+ ```
606
+
607
+ The following options are available:
608
+ - `mkl_pardiso` Intel MKL Pardiso
609
+ - `superlu` SuperLU 4.3
610
+
611
+ The default is `mkl_pardiso` when the Intel MKL is loaded. Otherwise, the default will switch to `superlu`.
612
+
613
+ ### Kahan summation in extended precision mode
614
+
615
+ The `kahan3` and `kahan4` functions are now using the Kahan summation algorithm for extended precision model evaluation. Previously, this algorithm was replaced with 128-bit floating point addition and subtraction in releases that support extended precision mode. With this change, better than 128-bit floating precision is available when extended precision is enabled.
616
+ ```
617
+ devsim.set_parameter(name = "extended_model", value=True)
618
+ ```
619
+
620
+ The `testing/kahan_float128.py` test has been added.
621
+
622
+ ### Visual Studio 2022
623
+
624
+ The Microsoft Windows`win64` release version is now built using the Visual Studio 2022 compiler. For users needing extended precision on the Windows platform, the `msys` build is recommended.
625
+
626
+ ## Version 2.0.1
627
+
628
+ ### Update documentation files
629
+
630
+ The following files were updated in the text documentation distributed with the software.
631
+ - `CONTRIBUTING.md`
632
+ - `INSTALL.md`
633
+ - `README.md`
634
+
635
+ This was done to create a version to coincide with this paper in the Journal of Open Source Software.
636
+
637
+ Sanchez, J. E., (2022). DEVSIM: A TCAD Semiconductor Device Simulator. Journal of Open Source Software, 7(70), 3898, [https://doi.org/10.21105/joss.03898](https://doi.org/10.21105/joss.03898)
638
+
639
+ ### Update MKL Version
640
+
641
+ The release version of this software is build against version 2 of the Intel MKL, which corresponds to the latest version of Anaconda Python. If you have issues running `DEVSIM` with this new version, please contact us at [https://forum.devsim.org](https://forum.devsim.org) for assistance.
642
+
643
+ ### Update SYMDIFF reference
644
+
645
+ The submodule reference to `SYMDIFF` was updated due some changes to its build files. Some `SYMDIFF` build scripts in the `DEVSIM` repository were also updated.
646
+
647
+ ## Version 2.0.0
648
+
649
+ ### Versioned MKL DLL in release build
650
+
651
+ The Intel Math Kernel Library now uses versioned library names. Binary releases are now updated against the latest versioned dll names from MKL available in the Anaconda Python distribution.
652
+
653
+ ### Fixed issue in ramp function.
654
+
655
+ The `rampbias` function in the `devsim.python_packages.ramp` module has been fixed to properly reduce the bias when there is a convergence failure.
656
+
657
+ ### Transient Simulation
658
+
659
+ Fixed bug with `transient_tr` (trapezoidal) time integration method where the wrong sign was used to integrate previous time steps.
660
+
661
+ Fixed bug in the charge error calculation, which calculates the simulation result with that a forward difference projection.
662
+
663
+ Added `testing/transient_rc.py` test which compares simulation with analytic result for RC circuit.
664
+
665
+ Added `set_initial_condition` command to provide initial transient conditions based on current solution.
666
+
667
+ ### Create interface from node pairs
668
+
669
+ Added `create_interface_from_nodes` to make it possible to add interface from non-coincident pairs of nodes.
670
+
671
+ ### Solver
672
+
673
+ #### Convergence Tests
674
+
675
+ The `maximum_error` and `maximum_divergence` options where added to the `solve` command. If the absolute error of any iteration goes above `maximum_error`, the simulation stops with a convergence failure. The `maximum_divergence` is the maximum number of iterations that the simulator error may increase before stopping.
676
+
677
+ #### Verbosity
678
+
679
+ During the `solve`, circuit node and circuit solution information is no longer printed to the screen for the default verbosity level. In addition, the number of equations per device and region is no longer displayed at the start of the first iteration.
680
+
681
+ #### SuperLU
682
+
683
+ The code now supports newer versions of `SuperLU`. The release version is still using SuperLU 4.3 for the iterative solution method, and the Intel MKL Pardiso for the direct solve method.
684
+
685
+ #### Simulation Matrix
686
+
687
+ The `get_matrix_and_rhs` command was not properly accepting the `format` parameter, and was always returning the same type.
688
+
689
+ ### Build Scripts
690
+
691
+ The build scripts have been updated on all platforms to be less dependent on specific Python 3 versions.
692
+
693
+ An updated fedora build script has been added. It uses the system installed `SuperLU` as the direct solver.
694
+
695
+ ### Documentation Files
696
+
697
+ Some out of date files (e.g. RELEASE, INSTALL, . . .) have been removed. The [README.md](README.md) has been updated and the [INSTALL.md](INSTALL.md) have been updated.
698
+
699
+ ### Command Options
700
+
701
+ The `variable_name` option is no longer recognized for the `devsim.contact_equation` and `devsim.interface_equation` as it was not being used.
702
+
703
+ ## Version 1.6.0
704
+
705
+ ### Array Type Input and Output
706
+
707
+ In most circumstances, the software now returns numerical data using the Python `array` class. This is more efficient than using standard lists, as it encapsulates a contiguous block of memory. More information about this class can be found at [https://docs.python.org/3/library/array.html](https://docs.python.org/3/library/array.html). The representation can be easily converted to lists and `numpy` arrays for efficient manipulation.
708
+
709
+ When accepting user input involving lists of homogenous data, such as `set_node_values` the user may enter data using either a list, string of bytes, or the `array` class. It may also be used to input `numpy` arrays or any other class with a `tobytes` method.
710
+
711
+ ### Get Matrix and RHS for External Use
712
+
713
+ The `get_matrix_and_rhs` command has been added to assemble the static and dynamic matrices, as well as their right hand sides, based on the current state of the device being simulated. The `format` option is used to specify the sparse matrix format, which may be either in the compressed column or compressed row formats, `csc` or `csr`.
714
+
715
+ ### Maximum Divergence Count
716
+
717
+ If the Newton iteration errors keep increasing for 20 iterations in a row, then the simulator stops. This limit was previously 5.
718
+
719
+ ### Mesh Visualization Element Orientation
720
+
721
+ Elements written to the `tecplot` format in 2d and 3d have node orderings compatible with the element connectivity in visualization formats. Specifying the `reorder=True` option in `get_element_node_list` will result in node ordering compatible with meshing and visualization software.
722
+
723
+ ## Version 1.5.1
724
+
725
+ ### Math Functions
726
+
727
+ The following inverse functions and their derivatives are now available in the model interpreter.
728
+ - `erf_inv` Inverse Error Function
729
+ - `erfc_inv` Inverse Complimentary Error Function
730
+ - `derf_invdx` Derivative of Inverse Error Function
731
+ - `derfc_invdx` Derivative of Complimentary Inverse Error Function
732
+
733
+ The Gauss-Fermi Integral, using Paasch's equations are now implemented.
734
+ - `gfi` Gauss-Fermi Integral
735
+ - `dgfidx` Derivative of Gauss-Fermi Integral
736
+ - `igfi` Inverse Gauss-Fermi Integral
737
+ - `digfidx` Derivative of Inverse Gauss-Fermi Integral
738
+
739
+ Each of these functions take two arguments, `zeta` and `s`. The derivatives with respect to the first argument are provided. Please see `testing/GaussFermi.py` for an example.
740
+
741
+ In extended precision mode, the following functions are now evaluated with full extended precision.
742
+ - `Fermi`
743
+ - `dFermidx`
744
+ - `InvFermi`
745
+ - `dInvFermidx`
746
+
747
+ The following double precision tests:
748
+
749
+ - `testing/Fermi1.py` Fermi Integral Test
750
+ - `testing/GaussFermi.py` Gauss Fermi Integral Test
751
+
752
+ Have extended precision variants:
753
+
754
+ - `testing/Fermi1_float128.py`
755
+ - `testing/GaussFermi_float128.py`
756
+
757
+ ### Installation Script
758
+
759
+ A new installation script is in the base directory of the package.
760
+ It provides instructions of completing the installation to the `python` environment without having to set the `PYTHONPATH` environment variable.
761
+ It notifies the user of missing components to finish the installation within an `Anaconda` or `Miniconda` environment.
762
+
763
+
764
+ To use the script, use the following command inside of the `devsim` directory.
765
+
766
+ ```
767
+ python install.py
768
+ ```
769
+
770
+ The install script will write a file named `lib/setup.py`, which can be used to complete the installation using `pip`. The script provides instructions for the installation and deinstallation of `devsim`.
771
+
772
+ ```
773
+ INFO: Writing setup.py
774
+ INFO:
775
+ INFO: Please type the following command to install devsim:
776
+ INFO: pip install -e lib
777
+ INFO:
778
+ INFO: To remove the file, type:
779
+ INFO: pip uninstall devsim
780
+ ```
781
+
782
+ ## Version 1.5.0
783
+
784
+ The `custom_equation` command has been modified to require a third return value. This boolean value denotes whether the matrix entries should be row permutated or not. For the bulk equations this value should be `True`. For interface and contact boundary conditions, this value should be `False`.
785
+
786
+ It is now possible to replace an existing `custom_equation`.
787
+
788
+ The file `examples/diode/diode_1d_custom.py` demonstrates custom matrix assembly and can be directly compared to `examples/diode/diode_1d.py`.
789
+
790
+ The `EdgeNodeVolume` model is now available for the volume contained by an edge.
791
+
792
+ The `contact_equation` command now accepts 3 additional arguments.
793
+
794
+ - `edge_volume_model`
795
+ - `volume_node0_model`
796
+ - `volume_node1_model`
797
+
798
+ These options provide the ability to do volume integration on contact nodes.
799
+
800
+ The `equation` command has replaced the `volume_model` option with:
801
+
802
+ - `volume_node0_model`
803
+ - `volume_node1_model`
804
+
805
+ so that nodal quantities can be more localized.
806
+
807
+ More details are in the manual.
808
+
809
+ ## Version 1.4.14
810
+ ### Platforms
811
+
812
+ Windows 32 bit is no longer supported. Binary releases of the `Visual Studio 2019` `MSYS2/Mingw-w64` 64-bit builds are still available online.
813
+
814
+ On Linux, the releases are now on Centos 7, as Centos 6 has reached its end of life on November 30, 2020.
815
+
816
+ ### C++ Standard
817
+
818
+ The C++ standard has been raised to C++17.
819
+
820
+ ## Version 1.4.13
821
+
822
+ The node indexes with the maximum error for each equation will be printed when `debug_level` is `verbose`.
823
+
824
+ ```
825
+ devsim.set_parameter(name="debug_level", value="verbose")
826
+ ```
827
+
828
+ These are printed as `RelErrorNode` and `AbsErrorNode`:
829
+
830
+ ```
831
+ Region: "gate" RelError: 5.21531e-14 AbsError: 4.91520e+04
832
+ Equation: "ElectronContinuityEquation" RelError: 4.91520e-16 AbsError: 4.91520e+04
833
+ RelErrorNode: 129 AbsErrorNode: 129
834
+ ```
835
+
836
+ This information is also returned when using the `info=True` option on the `solve` command for each equation on each region of a device.
837
+
838
+ If the `info` flag is set to `True` on the `solve` command, the iteration information will be returned, and an exception for convergence will no longer be thrown. It is the responsibility of the caller to test the result of the `solve` command to see if the simulation converged. Other types of exceptions, such as floating point errors, will still result in a Python exception that needs to be caught.
839
+
840
+
841
+ ## Version 1.4.12
842
+
843
+ Element assembly for calculation of current and charges from the device into the circuit equation are fixed. These tests are added:
844
+
845
+ - `testing/cap_2d_edge.py`
846
+ - `testing/cap_2d_element.py`
847
+ - `testing/cap_3d_edge.py`
848
+ - `testing/cap_3d_element.py`
849
+
850
+ The `edge` variant is using standard edge based assembly, and the `element` variant is using element-based assembly.
851
+
852
+ ## Version 1.4.11
853
+
854
+ The `element_pair_from_edge_model` is available to calculate element edge components averaged onto each node of the element edge. This makes it possible to create an edge weighting scheme different from those used in `element_from_edge_model`.
855
+
856
+ Fixed issue where command option names where not always shown in the documentation.
857
+
858
+ The platform specific notes now clarify that any version of Python 3 (3.6 or higher) is supported.
859
+
860
+ - `linux.txt`
861
+ - `windows.txt`
862
+ - `macos.txt`
863
+
864
+ ## Version 1.4.10
865
+
866
+ Fixed crash when evaluating element edge model in 3D.
867
+
868
+ Fixed potential error using `delete_node_model` and similar deletion commands.
869
+
870
+ ## Version 1.4.9
871
+
872
+ Support for loading mesh files containing element edge data.
873
+
874
+ ## Version 1.4.8
875
+
876
+ In transient mode, the convergence test was flawed so that the `charge_error` was the only convergence check required for convergence. The software now ensures all convergence criteria are met.
877
+
878
+ ## Version 1.4.7
879
+
880
+ ### Models
881
+
882
+ In the simple physics models, the sign for time-derivative terms was wrong for the electron and hole continuity equations. This affects small-signal and noise simulations. The example at `examples/diode/ssac_diode.py` was updated to reflect the change.
883
+
884
+ ### Platforms
885
+
886
+ Fix build script issue for macOS on Travis CI, updated the compiler to `g++-9`.
887
+
888
+ Update Centos 6 build from `devtoolset-6` to `devtoolset-8`.
889
+
890
+ ## Version 1.4.6
891
+
892
+ ### Version Information
893
+
894
+ Parameter `info` can be queried for getting version information. The file `testing/info.py` contains an example.
895
+
896
+ ```
897
+ python info.py
898
+ {'copyright': 'Copyright © 2009-2020 DEVSIM LLC', 'direct_solver': 'mkl_pardiso', 'extended_precision': True, 'license': 'Apache License, Version 2.0', 'version': '1.4.6', 'website': 'https://devsim.org'}
899
+ ```
900
+
901
+ ### Extended Precision
902
+
903
+ The example `examples/diode/gmsh_diode3d_float128.py` provides an example where extended precision is enabled.
904
+
905
+ ### Python Formatting
906
+
907
+ The Python scripts in the `examples` and `testing` directories have been reformatted to be more consistent with language standards.
908
+
909
+ ### Platforms
910
+
911
+ Microsoft Windows 10 is supported and is now compiled using Microsoft Visual Studio 2019.
912
+
913
+ Microsoft Windows 7 is no longer supported, as Microsoft has dropped support as of January 14, 2020.
914
+
915
+ ### External Meshing
916
+
917
+ Support for reading meshes from Genius Device Simulator has been completely removed from DEVSIM.
918
+
919
+
920
+ ## Version 1.4.5
921
+
922
+ * Platform Support:
923
+ * An MSYS2/Mingw-w64 build is available for 64-bit Windows. This build, labeled `devsim_msys_v1.4.5`, enables the use of the 128-bit floating point precision already available on the macOS and Linux platforms.
924
+
925
+ ## Version 1.4.4
926
+
927
+ * Bug Fixes:
928
+ * Intermittent crash on Windows 10 at the end of the program
929
+ * CHANGES.md containing version changes in markdown format.
930
+ * Internal changes:
931
+ * Regression system script refactored to Python.
932
+ * Refactor threading code using C++11 functions
933
+ * Refactor timing functions for verbose mode using C++11 functions.
934
+ * Refactor FPE detection code to C++11 standard.
935
+