LightWave2D
Badge |
Status |
|---|---|
Python versions |
|
Documentation |
|
Continuous integration |
|
Test coverage |
|
PyPI package |
|
PyPI downloads |
|
Anaconda package |
|
Anaconda downloads |
LightWave2D is a software designed for comprehensive 2D Finite-Difference Time-Domain (FDTD) simulations, featuring a user-friendly installation and operation process. The characterization of wave propagation, scattering, and diffraction within LightWave2D is determined by a set of specific components, as illustrated in the subsequent figure.
LightWave2D integrates various components, including waveguides, scatterers (squares, circles, ellipses, triangles, lenses), gratings, and resonators. Additional parameters governing the simulation are contingent upon the attributes of the components and the simulation setup.
Key Features
Intuitive API for configuring simulations.
Support for waveguides, scatterers, gratings, and resonators.
Built-in tools for rendering field animations.
Extensive gallery of examples in the documentation.
Documentation
All the latest available documentation is available here or you can click the following badge:
Installation
Install the published package with pip:
>>> pip install LightWave2DBuilding Documentation Locally
To generate the HTML documentation on your machine, install the optional dependencies and run:
pip install .[documentation]
cd docs && make html
firefox build/html/index.htmlCoding examples
LightWave2D was developed with the aim of being an intuitive and easy to use tool. All dimensional arguments can now be provided using pint quantities or strings with units. Below are two examples that illustrate this:
Spherical scatterer
from LightWave2D.grid import Grid
from LightWave2D.experiment import Experiment
from MPSPlots import colormaps
from TypedUnit import ureg
grid = Grid(
resolution=0.1 * ureg.micrometer,
size_x=32 * ureg.micrometer,
size_y=20 * ureg.micrometer,
n_steps=300
)
experiment = Experiment(grid=grid)
scatterer = experiment.add_circle(
position=('30%', '50%'),
epsilon_r=2,
radius=3 * ureg.micrometer
)
source = experiment.add_line_source(
wavelength=1550 * ureg.nanometer,
position_0=('10%', '100%'),
position_1=('10%', '0%'),
amplitude=10,
)
experiment.add_pml(order=1, width="10%", sigma_max=5000 * ureg.siemens / ureg.meter)
experiment.run()
animation = experiment.render_propagation(
skip_frame=5,
colormap=colormaps.polytechnique.red_black_blue
)
animation.save('./spherical_scatterer.gif', writer='Pillow', fps=10)
Ring resonator
from LightWave2D.grid import Grid
from LightWave2D.experiment import Experiment
from MPSPlots.colormaps import polytechnique
from TypedUnit import ureg
grid = Grid(
resolution=0.1 * ureg.micrometer,
size_x=50 * ureg.micrometer,
size_y=30 * ureg.micrometer,
n_steps=800
)
experiment = Experiment(grid=grid)
scatterer = experiment.add_ring_resonator(
position=('35%', '50%'),
epsilon_r=1.5,
inner_radius=4 * ureg.micrometer,
width=2 * ureg.micrometer
)
source = experiment.add_point_source(
wavelength=1550 * ureg.nanometer,
position=('25%', '50%'),
amplitude=100,
)
experiment.add_pml(order=1, width="10%", sigma_max=5000 * ureg.siemens / ureg.meter)
experiment.run()
animation = experiment.render_propagation(skip_frame=5, colormap=polytechnique.red_black_blue)
animation.save('./resonator.gif', writer='Pillow', fps=10)
Lens
from LightWave2D.grid import Grid
from LightWave2D.experiment import Experiment
from MPSPlots import colormaps
from TypedUnit import ureg
grid = Grid(
resolution=0.1 * ureg.micrometer,
size_x=60 * ureg.micrometer,
size_y=30 * ureg.micrometer,
n_steps=1200
)
experiment = Experiment(grid=grid)
scatterer = experiment.add_lens(
position=('35%', '50%'),
epsilon_r=2,
curvature=10 * ureg.micrometer,
width=5 * ureg.micrometer
)
source = experiment.add_point_source(
wavelength=1550 * ureg.nanometer,
position=('10%', '50%'),
amplitude=10,
)
experiment.add_pml(order=1, width="10%", sigma_max=5000 * ureg.siemens / ureg.meter)
experiment.run()
experiment.plot_frame(
frame_number=-1,
enhance_contrast=5,
colormap=colormaps.polytechnique.red_black_blue
)
animation = experiment.render_propagation(
skip_frame=5,
colormap=colormaps.polytechnique.red_black_blue
)
animation.save('./lens.gif', writer='Pillow', fps=10)
Plenty of other examples are available online; see the examples section of the documentation.
Testing
To test locally (with cloning the GitHub repository) you’ll need to install the dependencies and run the coverage command as
>>> git clone https://github.com/MartinPdeS/LightWave2D.git
>>> cd LightWave2D
>>> pip install -r requirements/requirements.txt
>>> coverage run --source=LightWave2D --module pytest --verbose tests
>>> coverage report --show-missingContributing
Contributions are welcome! Feel free to open an issue or submit a pull request on GitHub.
Contact Information
As of 2024 the project is still under development if you want to collaborate it would be a pleasure. I encourage you to contact me.
LightWave2D was written by Martin Poinsinet de Sivry-Houle .
1 maintainer
Metadata
1 maintainer
Release files for LightWave2D 0.10.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
Total release size: 34.7 MB
Release files / lightwave2d-0.10.2-cp314-cp314-win_amd64.whl
| Download URL | lightwave2d-0.10.2-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 7.5 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
47a66a26ae0602c91b303265bce8b784298d3259c9462d9a5be499ae039b5d4a
|
|
BLAKE2b-256 checksum How to use checksums |
7f6eb1270ef272a93bfcff201e55c25323d47f6bd25973097508ff0d37f51891
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
| Download URL | lightwave2d-0.10.2-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 2.1 MB |
| Tags | CPython 3.14 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
ecfd545be0ef39ca2b7c691559e2e4fe6677712e2bef1ede5c276824bd570885
|
|
BLAKE2b-256 checksum How to use checksums |
6734ca045d93ebab87517b8583e4be68618124e3dd2b43280a8524b1893af077
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp314-cp314-macosx_26_0_arm64.whl
| Download URL | lightwave2d-0.10.2-cp314-cp314-macosx_26_0_arm64.whl |
|---|---|
| Size | 1.5 MB |
| Tags | CPython 3.14 macOS 26.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
e4e2e089082f9662200267d448ab77b52fa5107672ca361bf9dcdcf77453ba15
|
|
BLAKE2b-256 checksum How to use checksums |
7e331adfc1f7290db150cdb2e3f93263f1b35c3239963edfde0da165d271d72f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp313-cp313-win_amd64.whl
| Download URL | lightwave2d-0.10.2-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 6.0 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
f00e48adeceb30e7ed7ca9c22145375a739c1fd43dee7b8cc1973c1baa12a12e
|
|
BLAKE2b-256 checksum How to use checksums |
883ebac1f84cfaea2e762f55ad367d5bd6d776fb0173f75e2f7e99930f7fe92e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
| Download URL | lightwave2d-0.10.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 1.9 MB |
| Tags | CPython 3.13 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
594dd6e3b33690bd8bb190ec1206df9731d0db04c450f3b3dd8ead0f81fb5be6
|
|
BLAKE2b-256 checksum How to use checksums |
0fdcf4f5b5be6291491100656aedad2c574bcfd522c34219ac0ea6cf278a4771
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp313-cp313-macosx_26_0_arm64.whl
| Download URL | lightwave2d-0.10.2-cp313-cp313-macosx_26_0_arm64.whl |
|---|---|
| Size | 1.4 MB |
| Tags | CPython 3.13 macOS 26.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a117923fd4375a219660656da84f966fe96ad99276773f7bdcb825a5db7a6fb3
|
|
BLAKE2b-256 checksum How to use checksums |
14df1403ea9998a56fa6a38287795fd5e174d68d97bcb26c6e6d5bb014f3534f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp312-cp312-win_amd64.whl
| Download URL | lightwave2d-0.10.2-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.8 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
5eee70f09610125ebf295dcccdae47cf8d55b0d6d9ffeceb28e1818c59ee76d4
|
|
BLAKE2b-256 checksum How to use checksums |
32662dc22518f80d0b8933012d34b2ba370cd4071598e4297cd9eff92287475f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
| Download URL | lightwave2d-0.10.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 1.8 MB |
| Tags | CPython 3.12 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
04365e973987aa1587576a4358a0e634335ee888b0220381c37636602fbb9a65
|
|
BLAKE2b-256 checksum How to use checksums |
0efb1490828a88cb85273a38a64ba9a9bbb3f8823a93a1635923b8b209290b29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp312-cp312-macosx_26_0_arm64.whl
| Download URL | lightwave2d-0.10.2-cp312-cp312-macosx_26_0_arm64.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.12 macOS 26.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
cb00d93bd94a4cfb6e33eb56bc4d15d25a13be28169fadc830178082dd02e53e
|
|
BLAKE2b-256 checksum How to use checksums |
d924c37a78e78755eec75f7891289df0acdf861bb4cc774570314f783a72223f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp311-cp311-win_amd64.whl
| Download URL | lightwave2d-0.10.2-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 3.6 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
c4338761eb062a6be38e34bfd987f6ee048213fa69d0cb948bb32d02ba90b096
|
|
BLAKE2b-256 checksum How to use checksums |
f2fd13cf8a85e17e5c362c828c66f3b6ef188c7eec2953f00d5a3c4f620a21de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
| Download URL | lightwave2d-0.10.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 1.6 MB |
| Tags | CPython 3.11 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
6aef02a78e33e1561a45b74190df641c03d05279fb36ef92a84793e1a9caff16
|
|
BLAKE2b-256 checksum How to use checksums |
f8b319eca54e26b436368e973a5fc36dce57605449910cf6e7f65de200855053
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / lightwave2d-0.10.2-cp311-cp311-macosx_26_0_arm64.whl
| Download URL | lightwave2d-0.10.2-cp311-cp311-macosx_26_0_arm64.whl |
|---|---|
| Size | 1.2 MB |
| Tags | CPython 3.11 macOS 26.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
16d9234004761757ebd07ba42f7e4f90c59c98b3067e6033907eca8ed56a6ab1
|
|
BLAKE2b-256 checksum How to use checksums |
7bb9e12b775a60734e7e3972fa251133cb334518f4a821087c1ee3deefb8216d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
