LyceanEM
LyceanEM: A python package for virtual prototyping of antenna arrays, time and frequency domain channel modelling - Published in JOSS (2023)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
1 of 5 committers (20.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Python codebase for LyceanEM
Basic Info
- Host: GitHub
- Owner: LyceanEM
- License: gpl-3.0
- Language: Python
- Default Branch: master
- Size: 41.1 MB
Statistics
- Stars: 25
- Watchers: 5
- Forks: 3
- Open Issues: 0
- Releases: 6
Metadata Files
README.md
LyceanEM

LyceanEM was conceived to enable rapid assesments of the suitability of difference antenna apertures for a wide range of platforms. This is based upon the use of ray tracing to determine the field of view of points of interest on the platform, whether building, train, plane, or mobile phone handset. Allowing the application of Wheelers formulation of the gain of an aperture.
This has been developed further since that point to include a frequency domain propagation model, allowing for antenna arrays and aperture antennas to be simulated with environment scattering.
Further development is planned for time domain modelling, computational efficiency, and eventually a Finite-Difference Time-Domain algorithm may be implemented to allow for modelling of a wider range of situations, or possibly hybrid modelling. This would use the FDTD algorithm for near field calculations, while using the ray tracing for more sparse situations.
Further documentation can be found here.
If you use LyceanEM in an academic project, please cite our paper:
Core Features
- 3D Visualization of Platform and Antenna Arrays
- Aperture Projection
- Raycasting
- Frequency Domain Electromagnetics Modelling for scattering, antennas, and antenna array patterns
- Time Domain Electromagnetics Modelling for scattering, antennas, and antenna array patterns
- GPU acceleration of core operations
Supported Platforms
The package has been tested on:
- Ubuntu and Mint 18.04,20.04,and 22.04
- Windows 10 64-bit
With Python versions:
- 3.8
- 3.9
- 3.10
- 3.11
- 3.12
Installation
LyceanEM uses CUDA for GPU acceleration. The advised installation method is to use Conda to setup a virtual
environment, and then the lyceanem package can be installed from the lyceanem channel.
```
$ conda install -c lyceanem lyceanem
```
Development Roadmap
LyceanEM is electromagnetics simulation software that is used by researchers and engineers in a variety of fields. The
software is currently under development, and the developers have outlined a roadmap for future changes. The roadmap
includes three key areas:
- Computational efficiency and scalability: The developers plan to improve the computational efficiency of
LyceanEMso that it can be used on a wider range of hardware platforms, including desktop computers and high-performance computing (HPC) clusters. This will makeLyceanEMmore accessible to a wider range of users. It is the intention of the developers to support antenna arrays with multiple billon antenna elements,Giga-scaleantenna arrays.Complete! - Core propagation engine: The developers plan to improve the core propagation engine of
LyceanEMto include more realistic models of lossy propagation, atmospheric effects for each layer of the atmosphere, and dynamic environments. This will makeLyceanEMmore accurate and versatile for a wider range of applications.Complete! - Modelling fidelity: The developers plan to add new features to
LyceanEMthat will allow users to model electromagnetic systems with greater fidelity. This includes support for importing antenna patterns and time domain sources, as well as the development of open source standards for antenna array designs, antenna patterns and field sources, and wireless power transfer.Complete!
Here are some specific ways that users can contribute to the development of LyceanEM:
- Report bugs: If you find a bug in
LyceanEM, please report it to the developers so that they can fix it. - Submit patches: If you know how to fix a bug or add a new feature, please submit a pull request to the developers.
- Donate: If you would like to support the development of
LyceanEM, you can make a donation to the developers.
Your contributions will help to make LyceanEM the best possible electromagnetics simulation software for a wide range
of users. Thank you for your support!
Resources
Owner
- Name: Timothy Pelham
- Login: LyceanEM
- Kind: user
- Location: Bristol
- Company: University of Bristol
- Website: https://lyceanem.com/
- Twitter: M0LYNX
- Repositories: 4
- Profile: https://github.com/LyceanEM
Research Fellow at the University of Bristol Director for Lycean Solutions Limited
JOSS Publication
LyceanEM: A python package for virtual prototyping of antenna arrays, time and frequency domain channel modelling
Authors
Tags
electromagnetics antenna arrays virtual prototyping channel modelling mobile communications satellite communications radar systemsCitation (CITATION.cff)
cff-version: "1.2.0"
authors:
- family-names: Pelham
given-names: Timothy G.
orcid: "https://orcid.org/0000-0002-8085-1264"
doi: 10.5281/zenodo.8026567
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Pelham
given-names: Timothy G.
orcid: "https://orcid.org/0000-0002-8085-1264"
date-published: 2023-06-12
doi: 10.21105/joss.05234
issn: 2475-9066
issue: 86
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 5234
title: "LyceanEM: A python package for virtual prototyping of antenna
arrays, time and frequency domain channel modelling"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.05234"
volume: 8
title: "LyceanEM: A python package for virtual prototyping of antenna
arrays, time and frequency domain channel modelling"
GitHub Events
Total
- Create event: 6
- Issues event: 1
- Release event: 1
- Watch event: 5
- Delete event: 1
- Push event: 172
- Pull request event: 7
Last Year
- Create event: 6
- Issues event: 1
- Release event: 1
- Watch event: 5
- Delete event: 1
- Push event: 172
- Pull request event: 7
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| LyceanEM | 6****M | 256 |
| Timothy Pelham | t****m@b****k | 135 |
| tf17270 | t****8@g****m | 134 |
| Timothy Pelham | t****n@g****m | 2 |
| Timothy Pelham | 6****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 5
- Total pull requests: 14
- Average time to close issues: 5 months
- Average time to close pull requests: about 2 hours
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 2.4
- Average comments per pull request: 0.0
- Merged pull requests: 13
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 5
- Average time to close issues: N/A
- Average time to close pull requests: 7 minutes
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- generein (4)
- tf17270 (1)
Pull Request Authors
- LyceanEM (12)
- tf17270 (11)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- actions/dependency-review-action v2 composite
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/checkout v3 composite
- actions/setup-python v3 composite
- pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
- cupy *
- importlib_metadata *
- lyceanem *
- matplotlib *
- numba *
- numpy *
- open3d *
- scipy *
- setuptools ==63.2.0
- solidpython *
- sphinx *
- sphinx_gallery *
- sphinx_rtd_theme *
- sphinxcontrib-bibtex *
- cupy *
- importlib_resources *
- lyceanem *
- matplotlib *
- numba *
- numpy *
- open3d ==0.9.0.0
- packaging *
- scipy *
- setuptools *
- solidpython *
- tqdm *
