Skip to content

DEISM integration - #20

Open
SilvinWillemsen wants to merge 8 commits into
developfrom
sim/deism
Open

DEISM integration#20
SilvinWillemsen wants to merge 8 commits into
developfrom
sim/deism

Conversation

@SilvinWillemsen

Copy link
Copy Markdown
Contributor

No description provided.

@mberz mberz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ZeyuXuAudio,

Thanks for your work on the interface! Since the PR lacks a description, I'm not sure what the state is at the moment. I had a brief look, and already wanted to mention a license incompatibility, see below.

Please let me know about the current state so we can make the next steps.

Comment thread deism_method/pyproject.toml Outdated
classifiers = [
"Development Status :: 4 - Beta",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: MIT License",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the interface code relies on Gmsh, the MIT license here is not compatible.
The use of Gmsh requires distributing under GPLv2 or later. (Most of CHORAS is licensed under GPLv3 for this reason).
Can you please update that? Of course this does not affect the original license of DEISM (MIT can can be redistributed as part of GPL licensed code, just not the other way around)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the license note, Marco, and it is now updated.

deism_interface used Gmsh, so the MIT classifier was wrong. It is now GPLv3, in line with the other method packages (de_method, dg_method, pyroomacoustics_method):

A short notice in deism_method/README.md: copyright 2026 Zeyu Xu and the CHORAS developers; GPLv3 because of Gmsh; that grant covers only this interface
This does not relicense DEISM. The deism library is not MIT (Fraunhofer license); it remains a PyPI dependency under its own terms, and Gmsh remains under its own GPL. I hope this is Ok for now. I also need to inform Emanuël of this; he is currently on vacation.

I also pinned deism==2.2.1.15 (was 2.2.1.14; current PyPI latest).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding the current status of the coupling, I think at least DEISM is sufficient to run on CHORAS, given convex rooms with planar surfaces. For nonconvex rooms and surfaces with multiple materials, it is still not supported. Maybe in the next version of DEISM, I will add this support.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks!

A short notice in deism_method/README.md: copyright 2026 Zeyu Xu and the CHORAS developers; GPLv3 because of Gmsh; that grant covers only this interface This does not relicense DEISM. The deism library is not MIT (Fraunhofer license); it remains a PyPI dependency under its own terms, and Gmsh remains under its own GPL. I hope this is Ok for now. I also need to inform Emanuël of this; he is currently on vacation.

Ah, I thought it was MIT, sorry I wasn't aware of that. I'm not familiar with the Fraunhofer license and will need to check its compatibility. Do you have insights into this?

The CHORAS wrapper uses Gmsh, so the interface cannot stay MIT; this matches the other method packages and leaves upstream deism under its own license.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants