aircompkit 1.0.0__tar.gz → 1.0.1__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.
Files changed (50) hide show
  1. aircompkit-1.0.0/LICENSE → aircompkit-1.0.1/LICENSE.txt +1 -1
  2. {aircompkit-1.0.0/src/aircompkit.egg-info → aircompkit-1.0.1}/PKG-INFO +15 -8
  3. {aircompkit-1.0.0 → aircompkit-1.0.1}/README.md +12 -5
  4. {aircompkit-1.0.0 → aircompkit-1.0.1}/pyproject.toml +4 -1
  5. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/__init__.py +1 -1
  6. {aircompkit-1.0.0 → aircompkit-1.0.1/src/aircompkit.egg-info}/PKG-INFO +15 -8
  7. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit.egg-info/SOURCES.txt +1 -1
  8. {aircompkit-1.0.0 → aircompkit-1.0.1}/setup.cfg +0 -0
  9. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/__main__.py +0 -0
  10. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/adversary/__init__.py +0 -0
  11. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/aircomp/__init__.py +0 -0
  12. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/aircomp/analytic.py +0 -0
  13. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/aircomp/power_control.py +0 -0
  14. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/aircomp/preprocess.py +0 -0
  15. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/bench.py +0 -0
  16. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/channel/__init__.py +0 -0
  17. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/cli.py +0 -0
  18. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/core/__init__.py +0 -0
  19. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/core/registry.py +0 -0
  20. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/core/result.py +0 -0
  21. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/core/rng.py +0 -0
  22. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/core/scenario.py +0 -0
  23. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/defense/__init__.py +0 -0
  24. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/defense/evaluate.py +0 -0
  25. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/devices/__init__.py +0 -0
  26. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/learning/__init__.py +0 -0
  27. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/learning/aggregate.py +0 -0
  28. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/learning/array.py +0 -0
  29. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/learning/bank.py +0 -0
  30. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/learning/data.py +0 -0
  31. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/learning/fl.py +0 -0
  32. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/learning/models.py +0 -0
  33. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/learning/partition.py +0 -0
  34. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/metrics/__init__.py +0 -0
  35. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/metrics/privacy.py +0 -0
  36. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/plot/__init__.py +0 -0
  37. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/receiver/__init__.py +0 -0
  38. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/reproduce/__init__.py +0 -0
  39. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/reproduce/yang2020.py +0 -0
  40. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit/reproduce/zhu2020.py +0 -0
  41. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit.egg-info/dependency_links.txt +0 -0
  42. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit.egg-info/entry_points.txt +0 -0
  43. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit.egg-info/requires.txt +0 -0
  44. {aircompkit-1.0.0 → aircompkit-1.0.1}/src/aircompkit.egg-info/top_level.txt +0 -0
  45. {aircompkit-1.0.0 → aircompkit-1.0.1}/tests/test_core.py +0 -0
  46. {aircompkit-1.0.0 → aircompkit-1.0.1}/tests/test_p1_aircomp.py +0 -0
  47. {aircompkit-1.0.0 → aircompkit-1.0.1}/tests/test_p2_mimo.py +0 -0
  48. {aircompkit-1.0.0 → aircompkit-1.0.1}/tests/test_p3_learning.py +0 -0
  49. {aircompkit-1.0.0 → aircompkit-1.0.1}/tests/test_p4_security.py +0 -0
  50. {aircompkit-1.0.0 → aircompkit-1.0.1}/tests/test_p5_bench_checks.py +0 -0
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2026 moyeendev
3
+ Copyright (c) 2026 M. A. Moyeen and Md. Abdul Awal
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
@@ -1,8 +1,8 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: aircompkit
3
- Version: 1.0.0
3
+ Version: 1.0.1
4
4
  Summary: Security-aware simulator for over-the-air computation and over-the-air federated learning.
5
- Author: M. A. Moyeen, Kuljeet Kaur, Anjali Agarwal
5
+ Author-email: "M. A. Moyeen" <moyeeniict@gmail.com>, "Md. Abdul Awal" <awal@cse.kuet.ac.bd>
6
6
  License: MIT
7
7
  Project-URL: Repository, https://github.com/moyeendev/AirCompKit
8
8
  Project-URL: Documentation, https://moyeendev.github.io/AirCompKit/
@@ -22,7 +22,7 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
22
22
  Classifier: Topic :: Communications
23
23
  Requires-Python: >=3.10
24
24
  Description-Content-Type: text/markdown
25
- License-File: LICENSE
25
+ License-File: LICENSE.txt
26
26
  Requires-Dist: numpy>=1.24
27
27
  Requires-Dist: pyyaml>=6
28
28
  Provides-Extra: torch
@@ -54,12 +54,14 @@ Dynamic: license-file
54
54
  [![CI](https://github.com/moyeendev/AirCompKit/actions/workflows/ci.yml/badge.svg)](https://github.com/moyeendev/AirCompKit/actions/workflows/ci.yml)
55
55
  [![Reproductions](https://github.com/moyeendev/AirCompKit/actions/workflows/reproduce.yml/badge.svg)](https://github.com/moyeendev/AirCompKit/actions/workflows/reproduce.yml)
56
56
  [![Docs](https://github.com/moyeendev/AirCompKit/actions/workflows/docs.yml/badge.svg)](https://moyeendev.github.io/AirCompKit/)
57
- [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
57
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
58
+ [![PyPI](https://img.shields.io/pypi/v/aircompkit.svg)](https://pypi.org/project/aircompkit/)
59
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.24388026.svg)](https://doi.org/10.5281/zenodo.24388026)
58
60
  [![Python 3.10-3.13](https://img.shields.io/badge/python-3.10--3.13-blue.svg)](pyproject.toml)
59
61
 
60
62
  **Security-aware simulator for over-the-air computation (AirComp) and over-the-air federated learning (OTA-FL).**
61
63
 
62
- > Status: **v1.0.0**. AirComp over AWGN, Rayleigh and Rician
64
+ > Status: **v1.0.1**. AirComp over AWGN, Rayleigh and Rician
63
65
  > channels (multi-antenna server, spatial correlation, path loss/shadowing, imperfect CSI,
64
66
  > phase errors), four power-control schemes, four receive beamformers, over-the-air
65
67
  > federated learning (FedSGD/FedAvg, NumPy models, MNIST/Fashion-MNIST/synthetic data,
@@ -93,7 +95,10 @@ AirComp results.
93
95
 
94
96
  ## Install
95
97
 
96
- From PyPI once v1.0.0 is released: `pip install aircompkit` (add `[plot]` for figures).
98
+ ```bash
99
+ pip install aircompkit # or "aircompkit[plot]" for figures
100
+ ```
101
+
97
102
  For development:
98
103
 
99
104
  ```bash
@@ -160,8 +165,10 @@ or the four IDX files in a folder and pass `--data-root` or set `AIRCOMPKIT_DATA
160
165
 
161
166
  ## Citing
162
167
 
163
- See [CITATION.cff](CITATION.cff). A SoftwareX paper is in preparation.
168
+ Please cite the archived software, DOI [10.5281/zenodo.24388026](https://doi.org/10.5281/zenodo.24388026)
169
+ (all versions; v1.0.0 is [10.5281/zenodo.24388027](https://doi.org/10.5281/zenodo.24388027)).
170
+ See [CITATION.cff](CITATION.cff). A journal paper is in preparation.
164
171
 
165
172
  ## License
166
173
 
167
- MIT. See [LICENSE](LICENSE).
174
+ MIT. See [LICENSE.txt](LICENSE.txt).
@@ -3,12 +3,14 @@
3
3
  [![CI](https://github.com/moyeendev/AirCompKit/actions/workflows/ci.yml/badge.svg)](https://github.com/moyeendev/AirCompKit/actions/workflows/ci.yml)
4
4
  [![Reproductions](https://github.com/moyeendev/AirCompKit/actions/workflows/reproduce.yml/badge.svg)](https://github.com/moyeendev/AirCompKit/actions/workflows/reproduce.yml)
5
5
  [![Docs](https://github.com/moyeendev/AirCompKit/actions/workflows/docs.yml/badge.svg)](https://moyeendev.github.io/AirCompKit/)
6
- [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
6
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
7
+ [![PyPI](https://img.shields.io/pypi/v/aircompkit.svg)](https://pypi.org/project/aircompkit/)
8
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.24388026.svg)](https://doi.org/10.5281/zenodo.24388026)
7
9
  [![Python 3.10-3.13](https://img.shields.io/badge/python-3.10--3.13-blue.svg)](pyproject.toml)
8
10
 
9
11
  **Security-aware simulator for over-the-air computation (AirComp) and over-the-air federated learning (OTA-FL).**
10
12
 
11
- > Status: **v1.0.0**. AirComp over AWGN, Rayleigh and Rician
13
+ > Status: **v1.0.1**. AirComp over AWGN, Rayleigh and Rician
12
14
  > channels (multi-antenna server, spatial correlation, path loss/shadowing, imperfect CSI,
13
15
  > phase errors), four power-control schemes, four receive beamformers, over-the-air
14
16
  > federated learning (FedSGD/FedAvg, NumPy models, MNIST/Fashion-MNIST/synthetic data,
@@ -42,7 +44,10 @@ AirComp results.
42
44
 
43
45
  ## Install
44
46
 
45
- From PyPI once v1.0.0 is released: `pip install aircompkit` (add `[plot]` for figures).
47
+ ```bash
48
+ pip install aircompkit # or "aircompkit[plot]" for figures
49
+ ```
50
+
46
51
  For development:
47
52
 
48
53
  ```bash
@@ -109,8 +114,10 @@ or the four IDX files in a folder and pass `--data-root` or set `AIRCOMPKIT_DATA
109
114
 
110
115
  ## Citing
111
116
 
112
- See [CITATION.cff](CITATION.cff). A SoftwareX paper is in preparation.
117
+ Please cite the archived software, DOI [10.5281/zenodo.24388026](https://doi.org/10.5281/zenodo.24388026)
118
+ (all versions; v1.0.0 is [10.5281/zenodo.24388027](https://doi.org/10.5281/zenodo.24388027)).
119
+ See [CITATION.cff](CITATION.cff). A journal paper is in preparation.
113
120
 
114
121
  ## License
115
122
 
116
- MIT. See [LICENSE](LICENSE).
123
+ MIT. See [LICENSE.txt](LICENSE.txt).
@@ -9,7 +9,10 @@ description = "Security-aware simulator for over-the-air computation and over-th
9
9
  readme = "README.md"
10
10
  license = { text = "MIT" }
11
11
  requires-python = ">=3.10"
12
- authors = [{ name = "M. A. Moyeen" }, { name = "Kuljeet Kaur" }, { name = "Anjali Agarwal" }]
12
+ authors = [
13
+ { name = "M. A. Moyeen", email = "moyeeniict@gmail.com" },
14
+ { name = "Md. Abdul Awal", email = "awal@cse.kuet.ac.bd" },
15
+ ]
13
16
  keywords = [
14
17
  "over-the-air computation", "AirComp", "federated learning", "wireless",
15
18
  "6G", "Byzantine robustness", "physical-layer security", "simulation",
@@ -1,6 +1,6 @@
1
1
  """AirCompKit: security-aware over-the-air computation simulator."""
2
2
 
3
- __version__ = "1.0.0"
3
+ __version__ = "1.0.1"
4
4
 
5
5
  # Importing the component packages registers their components.
6
6
  from aircompkit import ( # noqa: F401
@@ -1,8 +1,8 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: aircompkit
3
- Version: 1.0.0
3
+ Version: 1.0.1
4
4
  Summary: Security-aware simulator for over-the-air computation and over-the-air federated learning.
5
- Author: M. A. Moyeen, Kuljeet Kaur, Anjali Agarwal
5
+ Author-email: "M. A. Moyeen" <moyeeniict@gmail.com>, "Md. Abdul Awal" <awal@cse.kuet.ac.bd>
6
6
  License: MIT
7
7
  Project-URL: Repository, https://github.com/moyeendev/AirCompKit
8
8
  Project-URL: Documentation, https://moyeendev.github.io/AirCompKit/
@@ -22,7 +22,7 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
22
22
  Classifier: Topic :: Communications
23
23
  Requires-Python: >=3.10
24
24
  Description-Content-Type: text/markdown
25
- License-File: LICENSE
25
+ License-File: LICENSE.txt
26
26
  Requires-Dist: numpy>=1.24
27
27
  Requires-Dist: pyyaml>=6
28
28
  Provides-Extra: torch
@@ -54,12 +54,14 @@ Dynamic: license-file
54
54
  [![CI](https://github.com/moyeendev/AirCompKit/actions/workflows/ci.yml/badge.svg)](https://github.com/moyeendev/AirCompKit/actions/workflows/ci.yml)
55
55
  [![Reproductions](https://github.com/moyeendev/AirCompKit/actions/workflows/reproduce.yml/badge.svg)](https://github.com/moyeendev/AirCompKit/actions/workflows/reproduce.yml)
56
56
  [![Docs](https://github.com/moyeendev/AirCompKit/actions/workflows/docs.yml/badge.svg)](https://moyeendev.github.io/AirCompKit/)
57
- [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
57
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
58
+ [![PyPI](https://img.shields.io/pypi/v/aircompkit.svg)](https://pypi.org/project/aircompkit/)
59
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.24388026.svg)](https://doi.org/10.5281/zenodo.24388026)
58
60
  [![Python 3.10-3.13](https://img.shields.io/badge/python-3.10--3.13-blue.svg)](pyproject.toml)
59
61
 
60
62
  **Security-aware simulator for over-the-air computation (AirComp) and over-the-air federated learning (OTA-FL).**
61
63
 
62
- > Status: **v1.0.0**. AirComp over AWGN, Rayleigh and Rician
64
+ > Status: **v1.0.1**. AirComp over AWGN, Rayleigh and Rician
63
65
  > channels (multi-antenna server, spatial correlation, path loss/shadowing, imperfect CSI,
64
66
  > phase errors), four power-control schemes, four receive beamformers, over-the-air
65
67
  > federated learning (FedSGD/FedAvg, NumPy models, MNIST/Fashion-MNIST/synthetic data,
@@ -93,7 +95,10 @@ AirComp results.
93
95
 
94
96
  ## Install
95
97
 
96
- From PyPI once v1.0.0 is released: `pip install aircompkit` (add `[plot]` for figures).
98
+ ```bash
99
+ pip install aircompkit # or "aircompkit[plot]" for figures
100
+ ```
101
+
97
102
  For development:
98
103
 
99
104
  ```bash
@@ -160,8 +165,10 @@ or the four IDX files in a folder and pass `--data-root` or set `AIRCOMPKIT_DATA
160
165
 
161
166
  ## Citing
162
167
 
163
- See [CITATION.cff](CITATION.cff). A SoftwareX paper is in preparation.
168
+ Please cite the archived software, DOI [10.5281/zenodo.24388026](https://doi.org/10.5281/zenodo.24388026)
169
+ (all versions; v1.0.0 is [10.5281/zenodo.24388027](https://doi.org/10.5281/zenodo.24388027)).
170
+ See [CITATION.cff](CITATION.cff). A journal paper is in preparation.
164
171
 
165
172
  ## License
166
173
 
167
- MIT. See [LICENSE](LICENSE).
174
+ MIT. See [LICENSE.txt](LICENSE.txt).
@@ -1,4 +1,4 @@
1
- LICENSE
1
+ LICENSE.txt
2
2
  README.md
3
3
  pyproject.toml
4
4
  src/aircompkit/__init__.py
File without changes