{"id":24895374,"url":"https://github.com/ntia/lfmf-python","last_synced_at":"2025-03-27T15:25:44.722Z","repository":{"id":274078844,"uuid":"896234119","full_name":"NTIA/LFMF-python","owner":"NTIA","description":"Python wrapper for the NTIA/ITS implementation of the Low Frequency / Medium Frequency (LF/MF) Propagation Model. LF/MF predicts basic transmission loss in the frequency range 0.01 - 30 MHz for propagation paths over a smooth Earth and antenna heights less than 50 meters.","archived":false,"fork":false,"pushed_at":"2025-03-06T21:08:45.000Z","size":115,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T21:29:19.253Z","etag":null,"topics":["antenna","lfmf","propagation","proplib","python","spectrum"],"latest_commit_sha":null,"homepage":"https://ntia.github.io/propagation-library-wiki/models/LFMF","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NTIA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-29T20:54:02.000Z","updated_at":"2025-01-29T20:21:57.000Z","dependencies_parsed_at":"2025-01-24T19:22:35.908Z","dependency_job_id":"e6c732b2-bab8-46a2-8262-39cd617813b1","html_url":"https://github.com/NTIA/LFMF-python","commit_stats":null,"previous_names":["ntia/lfmf-python"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NTIA%2FLFMF-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NTIA%2FLFMF-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NTIA%2FLFMF-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NTIA%2FLFMF-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NTIA","download_url":"https://codeload.github.com/NTIA/LFMF-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245869962,"owners_count":20685949,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antenna","lfmf","propagation","proplib","python","spectrum"],"created_at":"2025-02-01T19:17:58.534Z","updated_at":"2025-03-27T15:25:44.699Z","avatar_url":"https://github.com/NTIA.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Low Frequency / Medium Frequency (LF/MF) Propagation Model, Python® Wrapper #\n\n[![NTIA/ITS PropLib][proplib-badge]][proplib-link]\n[![PyPI Release][pypi-release-badge]][pypi-release-link]\n[![GitHub Actions Unit Test Status][gh-actions-test-badge]][gh-actions-test-link]\n[![GitHub Issues][gh-issues-badge]][gh-issues-link]\n[![DOI][doi-badge]][doi-link]\n\n[proplib-badge]: https://img.shields.io/badge/PropLib-badge?label=%F0%9F%87%BA%F0%9F%87%B8%20NTIA%2FITS\u0026labelColor=162E51\u0026color=D63E04\n[proplib-link]: https://ntia.github.io/propagation-library-wiki\n[gh-actions-test-badge]: https://img.shields.io/github/actions/workflow/status/NTIA/LFMF-python/pytest.yml?branch=main\u0026logo=pytest\u0026logoColor=ffffff\u0026label=Tests\u0026labelColor=162E51\n[gh-actions-test-link]: https://github.com/NTIA/LFMF-python/actions/workflows/pytest.yml\n[pypi-release-badge]: https://img.shields.io/pypi/v/proplib-lfmf?logo=pypi\u0026logoColor=ffffff\u0026label=Release\u0026labelColor=162E51\u0026color=D63E04\n[pypi-release-link]: https://pypi.org/project/proplib-lfmf\n[gh-issues-badge]: https://img.shields.io/github/issues/NTIA/LFMF-python?logo=github\u0026label=Issues\u0026labelColor=162E51\n[gh-issues-link]: https://github.com/NTIA/LFMF-python/issues\n[doi-badge]: https://zenodo.org/badge/896234119.svg\n[doi-link]: https://zenodo.org/badge/latestdoi/896234119\n\nThis code repository contains a Python wrapper for the NTIA/ITS implementation of the\nLow Frequency / Medium Frequency (LF/MF) Propagation Model. LF/MF predicts basic transmission\nloss in the frequency range 0.01 - 30 MHz for propagation paths over a smooth Earth and antenna\nheights less than 50 meters. This Python package wraps the [NTIA/ITS C++ implementation](https://github.com/NTIA/LFMF).\n\n## Getting Started ##\n\nThis software is distributed on [PyPI](https://pypi.org/project/proplib-lfmf) and is easily installable\nusing the following command.\n\n```cmd\npip install proplib-lfmf\n```\n\nGeneral information about using this model is available on\n[its page on the **NTIA/ITS Propagation Library Wiki**](https://ntia.github.io/propagation-library-wiki/models/LFMF/).\nAdditionally, Python-specific instructions and code examples are available\n[here](https://ntia.github.io/propagation-library-wiki/models/LFMF/python).\n\nIf you're a developer and would like to contribute to or extend this repository,\nplease review the guide for contributors [here](CONTRIBUTING.md) or open an\n[issue](https://github.com/NTIA/LFMF-python/issues) to start a discussion.\n\n## Development ##\n\nThis repository contains code which wraps [the C++ shared library](https://github.com/NTIA/LFMF)\nas an importable Python module. If you wish to contribute to this repository,\ntesting your changes will require the inclusion of this shared library. You may retrieve\nthis either from the\n[relevant GitHub Releases page](https://github.com/NTIA/LFMF/releases), or by\ncompiling it yourself from the C++ source code. Either way, ensure that the shared library\n(`.dll`, `.dylib`, or `.so` file) is placed in `src/ITS/Propagation/LFMF/`, alongside `__init__.py`.\n\nBelow are the steps to build and install the Python package from the source code.\nWorking installations of Git and a [currently-supported version](https://devguide.python.org/versions/)\nof Python are required. Additional requirements exist if you want to compile the shared\nlibrary from C++ source code; see relevant build instructions\n[here](https://github.com/NTIA/LFMF?tab=readme-ov-file#configure-and-build).\n\n1. Optionally, configure and activate a virtual environment using a tool such as\n[`venv`](https://docs.python.org/3/library/venv.html) or\n[`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html).\n\n1. Clone this repository, then initialize the Git submodule containing the test data.\n\n    ```cmd\n    # Clone the repository\n    git clone https://github.com/NTIA/LFMF-python\n    cd LFMF-python\n\n    # Initialize Git submodule containing test data\n    git submodule init\n\n    # Clone the submodule\n    git submodule update\n    ```\n\n1. Download the shared library (`.dll`, `.so`, or `.dylib`) from a\n[GitHub Release](https://github.com/NTIA/LFMF/releases). Then place the\ndownloaded file in `src/ITS/Propagation/LFMF/` (alongside `__init__.py`).\n\n1. Install the local package and development dependencies into your current environment:\n\n    ```cmd\n    pip install .[dev]\n    ```\n\n1. To build the wheel for your platform:\n\n    ```cmd\n    hatchling build\n    ```\n\n### Running Tests ###\n\nPython unit tests can be run to confirm successful installation. You will need to\nclone this repository's test data submodule (as described above). Then, run the tests\nwith pytest using the following command.\n\n```cmd\npytest\n```\n\n## References ##\n\n- [ITS Propagation Library Wiki](https://ntia.github.io/propagation-library-wiki)\n- [LFMF Wiki Page](https://ntia.github.io/propagation-library-wiki/models/LFMF)\n- [`ITS.Propagation.LFMF` C++ API Reference](https://ntia.github.io/LFMF)\n- Bremmer, H. \"Terrestrial Radio Waves\" _Elsevier_, 1949.\n- DeMinco, N. \"Medium Frequency Propagation Prediction Techniques and Antenna Modeling for Intelligent Transportation Systems (ITS) Broadcast Applications\", [_NTIA Report 99-368_](https://www.its.bldrdoc.gov/publications/2399.aspx), August 1999\n- DeMinco, N. \"Ground-wave Analysis Model For MF Broadcast System\", [_NTIA Report 86-203_](https://www.its.bldrdoc.gov/publications/2226.aspx), September 1986\n- Sommerfeld, A. \"The propagation of waves in wireless telegraphy\", _Ann. Phys._, 1909, 28, p.665\n- Wait, J. \"Radiation From a Vertical Antenna Over a Curved Stratified Ground\", _Journal of Research of the National Bureau of Standards_.  Vol 56, No. 4, April 1956. Research Paper 2671\n\n## License ##\n\nSee [LICENSE](./LICENSE.md).\n\n\"Python\" and the Python logos are trademarks or registered trademarks of the Python Software Foundation, used by the National Telecommunications and Information Administration with permission from the Foundation.\n\n## Contact ##\n\nFor technical questions, contact \u003ccode@ntia.gov\u003e.\n\n## Disclaimer ##\n\nCertain commercial equipment, instruments, or materials are identified in this project were used for the convenience of the developers. In no case does such identification imply recommendation or endorsement by the National Telecommunications and Information Administration, nor does it imply that the material or equipment identified is necessarily the best available for the purpose.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntia%2Flfmf-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fntia%2Flfmf-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntia%2Flfmf-python/lists"}