iitmm 0.1.0__tar.gz
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.
- iitmm-0.1.0/PKG-INFO +77 -0
- iitmm-0.1.0/README.md +67 -0
- iitmm-0.1.0/pyproject.toml +77 -0
- iitmm-0.1.0/pyproject.toml.orig +67 -0
- iitmm-0.1.0/src/iitmm/__init__.py +1 -0
- iitmm-0.1.0/src/iitmm/bare_math.py +526 -0
- iitmm-0.1.0/src/iitmm/material.py +44 -0
- iitmm-0.1.0/src/iitmm/parameters.py +26 -0
- iitmm-0.1.0/src/iitmm/solvers.py +656 -0
- iitmm-0.1.0/src/iitmm/structures/__init__.py +10 -0
- iitmm-0.1.0/src/iitmm/structures/axially_symmetric/__init__.py +24 -0
- iitmm-0.1.0/src/iitmm/structures/axially_symmetric/axially_symmetric.py +226 -0
- iitmm-0.1.0/src/iitmm/structures/axially_symmetric/pixilated.py +119 -0
- iitmm-0.1.0/src/iitmm/structures/axially_symmetric/polygonal.py +316 -0
- iitmm-0.1.0/src/iitmm/structures/axially_symmetric/shifted_sphere.py +136 -0
- iitmm-0.1.0/src/iitmm/structures/axially_symmetric/spheroid.py +143 -0
- iitmm-0.1.0/src/iitmm/structures/axially_symmetric/up_based.py +207 -0
- iitmm-0.1.0/src/iitmm/structures/sphere.py +168 -0
- iitmm-0.1.0/src/iitmm/structures/sphere_multilayered.py +392 -0
- iitmm-0.1.0/src/iitmm/structures/structure.py +74 -0
- iitmm-0.1.0/src/iitmm/utils.py +78 -0
iitmm-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: iitmm
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Invariant Imbedding T-Matrix Method python codes
|
|
5
|
+
Requires-Dist: jax>=0.10.1
|
|
6
|
+
Requires-Dist: numba>=0.65.1
|
|
7
|
+
Requires-Dist: pywigxjpf>=1.13.3
|
|
8
|
+
Requires-Python: >=3.11
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
|
|
11
|
+
# Invariant Imbedding T-matrix method.
|
|
12
|
+
|
|
13
|
+
In this Python package, the T-matrix method calculation for dielectric particles is implemented.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Main features:
|
|
18
|
+
- written in Python with JAX
|
|
19
|
+
- connects to `treams` library
|
|
20
|
+
- supports axially symmetric particles
|
|
21
|
+
|
|
22
|
+
Things to keep in mind:
|
|
23
|
+
- Only dielectric particles are supported
|
|
24
|
+
- T-matrix is calculated in vacuum, so the particles are defined by their relative permittivity
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
# Development:
|
|
28
|
+
|
|
29
|
+
## Installation:
|
|
30
|
+
|
|
31
|
+
First, install `uv` package manager.
|
|
32
|
+
Then in the project root, create a virtual environment and install the dependencies:
|
|
33
|
+
```bash
|
|
34
|
+
uv sync
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Before committing:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
uv run ruff format
|
|
41
|
+
uv run ruff check
|
|
42
|
+
uv run pyright
|
|
43
|
+
uv run pytest
|
|
44
|
+
```
|
|
45
|
+
or
|
|
46
|
+
```bash
|
|
47
|
+
uv run pre-commit run --all-files
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
For running computationally heavy tests, use:
|
|
51
|
+
```bash
|
|
52
|
+
uv run pytest --run-computations
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Documentation:
|
|
56
|
+
|
|
57
|
+
The documentation is built with Sphinx.
|
|
58
|
+
|
|
59
|
+
Before building the documentation, install the dependencies:
|
|
60
|
+
```bash
|
|
61
|
+
uv sync --group docs
|
|
62
|
+
```
|
|
63
|
+
Then, build the documentation:
|
|
64
|
+
```bash
|
|
65
|
+
uv run sphinx-build docs docs/_build/html
|
|
66
|
+
```
|
|
67
|
+
You can also run a local server to view the documentation and automatically rebuild it when the source files change:
|
|
68
|
+
```bash
|
|
69
|
+
uv run sphinx-autobuild docs docs/_build/html
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Project Structure:
|
|
73
|
+
|
|
74
|
+
README.md - general description of the project
|
|
75
|
+
/src - folder for code placement
|
|
76
|
+
/docs - folder for documents placement
|
|
77
|
+
/tests - folder for tests placement
|
iitmm-0.1.0/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Invariant Imbedding T-matrix method.
|
|
2
|
+
|
|
3
|
+
In this Python package, the T-matrix method calculation for dielectric particles is implemented.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Main features:
|
|
8
|
+
- written in Python with JAX
|
|
9
|
+
- connects to `treams` library
|
|
10
|
+
- supports axially symmetric particles
|
|
11
|
+
|
|
12
|
+
Things to keep in mind:
|
|
13
|
+
- Only dielectric particles are supported
|
|
14
|
+
- T-matrix is calculated in vacuum, so the particles are defined by their relative permittivity
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
# Development:
|
|
18
|
+
|
|
19
|
+
## Installation:
|
|
20
|
+
|
|
21
|
+
First, install `uv` package manager.
|
|
22
|
+
Then in the project root, create a virtual environment and install the dependencies:
|
|
23
|
+
```bash
|
|
24
|
+
uv sync
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Before committing:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
uv run ruff format
|
|
31
|
+
uv run ruff check
|
|
32
|
+
uv run pyright
|
|
33
|
+
uv run pytest
|
|
34
|
+
```
|
|
35
|
+
or
|
|
36
|
+
```bash
|
|
37
|
+
uv run pre-commit run --all-files
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
For running computationally heavy tests, use:
|
|
41
|
+
```bash
|
|
42
|
+
uv run pytest --run-computations
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Documentation:
|
|
46
|
+
|
|
47
|
+
The documentation is built with Sphinx.
|
|
48
|
+
|
|
49
|
+
Before building the documentation, install the dependencies:
|
|
50
|
+
```bash
|
|
51
|
+
uv sync --group docs
|
|
52
|
+
```
|
|
53
|
+
Then, build the documentation:
|
|
54
|
+
```bash
|
|
55
|
+
uv run sphinx-build docs docs/_build/html
|
|
56
|
+
```
|
|
57
|
+
You can also run a local server to view the documentation and automatically rebuild it when the source files change:
|
|
58
|
+
```bash
|
|
59
|
+
uv run sphinx-autobuild docs docs/_build/html
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Project Structure:
|
|
63
|
+
|
|
64
|
+
README.md - general description of the project
|
|
65
|
+
/src - folder for code placement
|
|
66
|
+
/docs - folder for documents placement
|
|
67
|
+
/tests - folder for tests placement
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "iitmm"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "Invariant Imbedding T-Matrix Method python codes"
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.11"
|
|
7
|
+
dependencies = [
|
|
8
|
+
"jax>=0.10.1",
|
|
9
|
+
"numba>=0.65.1",
|
|
10
|
+
"pywigxjpf>=1.13.3",
|
|
11
|
+
]
|
|
12
|
+
|
|
13
|
+
[dependency-groups]
|
|
14
|
+
dev = [
|
|
15
|
+
"pytest>=9.1.0",
|
|
16
|
+
"pytest-cov>=7.1.0",
|
|
17
|
+
"matplotlib>=3.11.0",
|
|
18
|
+
"ipykernel>=7.3.0",
|
|
19
|
+
"pre-commit>=4.6.0",
|
|
20
|
+
"ruff>=0.15.20",
|
|
21
|
+
"tqdm>=4.68.3",
|
|
22
|
+
"pyright>=1.1.411",
|
|
23
|
+
{ include-group = "treams" },
|
|
24
|
+
]
|
|
25
|
+
docs = [
|
|
26
|
+
"myst-parser>=5.1.0",
|
|
27
|
+
"pydata-sphinx-theme>=0.23.0",
|
|
28
|
+
"sphinx>=9.0.4",
|
|
29
|
+
"sphinx-autobuild>=2025.8.25",
|
|
30
|
+
"sphinx-design>=0.7.0",
|
|
31
|
+
]
|
|
32
|
+
treams = [
|
|
33
|
+
"treams>=0.4.5",
|
|
34
|
+
"scipy<1.17",
|
|
35
|
+
]
|
|
36
|
+
|
|
37
|
+
[tool.uv]
|
|
38
|
+
exclude-newer = "7 days"
|
|
39
|
+
|
|
40
|
+
[tool.ruff]
|
|
41
|
+
line-length = 100
|
|
42
|
+
target-version = "py311"
|
|
43
|
+
|
|
44
|
+
[tool.ruff.lint]
|
|
45
|
+
select = [
|
|
46
|
+
"E",
|
|
47
|
+
"F",
|
|
48
|
+
"UP",
|
|
49
|
+
"B",
|
|
50
|
+
"SIM",
|
|
51
|
+
"W",
|
|
52
|
+
"D",
|
|
53
|
+
]
|
|
54
|
+
ignore = [
|
|
55
|
+
"D401",
|
|
56
|
+
"D102",
|
|
57
|
+
]
|
|
58
|
+
|
|
59
|
+
[tool.ruff.lint.pydocstyle]
|
|
60
|
+
convention = "numpy"
|
|
61
|
+
|
|
62
|
+
[tool.pyright]
|
|
63
|
+
include = ["src"]
|
|
64
|
+
typeCheckingMode = "standard"
|
|
65
|
+
|
|
66
|
+
[tool.pytest.ini_options]
|
|
67
|
+
addopts = [
|
|
68
|
+
"--cov=src",
|
|
69
|
+
"--cov-report=html",
|
|
70
|
+
"--cov-report=term:skip-covered",
|
|
71
|
+
"--cov-fail-under=100",
|
|
72
|
+
]
|
|
73
|
+
markers = ["computations: expensive test, run with --run-computations"]
|
|
74
|
+
|
|
75
|
+
[build-system]
|
|
76
|
+
requires = ["uv_build>=0.11.21,<0.12"]
|
|
77
|
+
build-backend = "uv_build"
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "iitmm"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "Invariant Imbedding T-Matrix Method python codes"
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.11"
|
|
7
|
+
dependencies = [
|
|
8
|
+
"jax>=0.10.1",
|
|
9
|
+
"numba>=0.65.1",
|
|
10
|
+
"pywigxjpf>=1.13.3",
|
|
11
|
+
]
|
|
12
|
+
|
|
13
|
+
[dependency-groups]
|
|
14
|
+
dev = [
|
|
15
|
+
"pytest>=9.1.0",
|
|
16
|
+
"pytest-cov>=7.1.0",
|
|
17
|
+
"matplotlib>=3.11.0",
|
|
18
|
+
"ipykernel>=7.3.0",
|
|
19
|
+
"pre-commit>=4.6.0",
|
|
20
|
+
"ruff>=0.15.20",
|
|
21
|
+
"tqdm>=4.68.3",
|
|
22
|
+
"pyright>=1.1.411",
|
|
23
|
+
{include-group = "treams"},
|
|
24
|
+
]
|
|
25
|
+
docs = [
|
|
26
|
+
"myst-parser>=5.1.0",
|
|
27
|
+
"pydata-sphinx-theme>=0.23.0",
|
|
28
|
+
"sphinx>=9.0.4",
|
|
29
|
+
"sphinx-autobuild>=2025.8.25",
|
|
30
|
+
"sphinx-design>=0.7.0",
|
|
31
|
+
]
|
|
32
|
+
treams = [
|
|
33
|
+
"treams>=0.4.5",
|
|
34
|
+
"scipy<1.17",
|
|
35
|
+
]
|
|
36
|
+
|
|
37
|
+
[tool.uv]
|
|
38
|
+
exclude-newer = "7 days"
|
|
39
|
+
|
|
40
|
+
[tool.ruff]
|
|
41
|
+
line-length = 100
|
|
42
|
+
target-version = "py311"
|
|
43
|
+
|
|
44
|
+
[tool.ruff.lint]
|
|
45
|
+
select = ["E", "F", "UP", "B", "SIM", "W", "D"]
|
|
46
|
+
# select= ["ALL"] # Uncomment this line to enable all checks
|
|
47
|
+
# preview = true # Uncomment this line to enable preview checks
|
|
48
|
+
ignore = ["D401", "D102"]
|
|
49
|
+
|
|
50
|
+
[tool.ruff.lint.pydocstyle]
|
|
51
|
+
convention = "numpy"
|
|
52
|
+
|
|
53
|
+
[tool.pyright]
|
|
54
|
+
include = ["src"]
|
|
55
|
+
typeCheckingMode = "standard"
|
|
56
|
+
|
|
57
|
+
[tool.pytest.ini_options]
|
|
58
|
+
addopts = ["--cov=src", "--cov-report=html", "--cov-report=term:skip-covered", "--cov-fail-under=100"]
|
|
59
|
+
markers = [
|
|
60
|
+
"computations: expensive test, run with --run-computations",
|
|
61
|
+
]
|
|
62
|
+
|
|
63
|
+
[build-system]
|
|
64
|
+
requires = ["uv_build>=0.11.21,<0.12"]
|
|
65
|
+
build-backend = "uv_build"
|
|
66
|
+
|
|
67
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""IITMM - Invariant Imbedding T-Matrix Method package."""
|