Devsim

Windows Python Support

The official ``python.org`` distribution is beter supported. This is since the ``python.org`` distribution does not appear to ship the ``zlib.dll``.

VTK Writer

[151](https://github.com/devsim/devsim/issues/151)

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.

Clang build on Windows

While the Windows version is still built with Visual Studio 2022, the build system now supports building with the Clang compilers.

Serialization of equation command

Write ``variable_update`` when writing the ``equation`` command to the devsim file format.

Simulation Matrix

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``.

macOS Build

Fix issue [149](https://github.com/devsim/devsim/issues/149) fix issue with macOS build scripts.

Linux support

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).

Clang format

Add `.clang-format` file to provide assist automatic formatting for new source code.

Get equation command

Fixed issue [145](https://github.com/devsim/devsim/issues/145). `get_equation_command` now provides the `variable_update` option that was used.

Exception propagation

Fixed issue where an internal C++ based exception, may not be caught properly on some platforms.

Documentation updates

The documentation has undergone major updates. Please see it at ``doc/devsim.pdf`` and online at [https://devsim.net](https://devsim.net).

Help Files

Updated instructions. Added additional documentation files.

| File | Purpose |
| --- | --- |
| [BUILD.md](BUILD.md) | Building from source |
| [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) | Code of conduct |
| [TEST.md](TEST.md) | Testing instructions |

and removed [install.py](install.py).

Database Command Removal

Remove commands:

* `create_db`
* `open_db`
* `close_db`
* `save_db`
* `add_db_entry`
* `get_db_entry`

This feature was only being used in the `bioapp1` examples, and those tests have been updated. This also removes the binary dependence on SQLite.

Python Scripts

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.

Data output

Reduction in Data File Sizes

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.

In this example, only the `NetDoping` field is written to the Tecplot data file.


devsim.write_devices(
file="mesh2d_reduced.tec",
type="tecplot",
include_test=lambda x: x in ("NetDoping",),
)



FLOOPS Data File Output

The `floops` option for `devsim.write_devices` has been removed.


Platform Support

Windows Build Issue

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.

Centos 7 End of Life

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`.