Skip to content

Commit 58d6bbe

Browse files
authored
Reorganize code, removing _orig submodule (#76)
* reorganize for easier development * fix docstring typo
1 parent 6b866ef commit 58d6bbe

28 files changed

+5069
-5200
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Change log
22

33
## Unreleased
4+
- Restructure codebase to integrate code originally in the `_orig` submodule within the main `src/fmmax` modules, separating the code available under the two licenses to the top (AGPL) and bottom (MIT) of each file.
45

56
## 1.4.2 (July 10, 2025)
67
- Avoid use of `jax.pure_callback` in the eigendecomposition. This requires jax newer than 0.4.36.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ If you use FMMAX, please consider citing [our paper](https://opg.optica.org/oe/f
7171
```
7272

7373
## License
74-
Some portions of FMMAX were created while the author was employed by Meta or by Meta collaborators, with copyright owned by Meta and available under the [MIT license](https://github.com/facebookresearch/fmmax/blob/main/LICENSE2). Other portions were created or substantially changed subsequently (copyright not owned by Meta) and are available under the [AGPL](https://github.com/facebookresearch/fmmax/blob/main/LICENSE). These are split on a file-by-file basis, with the file header indicating which license is applicable.
74+
Some portions of FMMAX were created while the author was employed by Meta or by Meta collaborators, with copyright owned by Meta and available under the [MIT license](https://github.com/facebookresearch/fmmax/blob/main/LICENSE2). Other portions were created or substantially changed subsequently (copyright not owned by Meta) and are available under the [AGPL](https://github.com/facebookresearch/fmmax/blob/main/LICENSE). Throughout the codebase, a given file may contain code that is owned by Meta, and code which is not. In such a file, the code owned by Meta will be at the end separated by a comment.
7575

7676
## References
7777
- [2012 Liu] V. Liu and S. Fan, [S4: A free electromagnetic solver for layered structures structures](https://www.sciencedirect.com/science/article/pii/S0010465512001658), _Comput. Phys. Commun._ **183**, 2233-2244 (2012).

src/fmmax/__init__.py

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# Copyright (c) 2025 Martin F. Schubert
1+
# FMMAX
2+
# Copyright (C) 2025 Martin F. Schubert
3+
4+
# This program is free software: you can redistribute it and/or modify
5+
# it under the terms of the GNU Affero General Public License as published by
6+
# the Free Software Foundation, either version 3 of the License, or
7+
# (at your option) any later version.
8+
9+
# This program is distributed in the hope that it will be useful,
10+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
# GNU Affero General Public License for more details.
13+
14+
# You should have received a copy of the GNU Affero General Public License
15+
# along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
"""FMMAX: Fourier modal method with jax.
17+
18+
Copyright (c) Martin F. Schubert
19+
"""
220

321
__version__ = "v1.4.2"
422

src/fmmax/_orig/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)