Skip to main content

A Python package that provides a secondary wrapper for the official Python API of the optical simulation software Lumerical, enabling easier usage in more complex scenarios.

Features:

  1. Wrap the original lsf (Lumerical script language) and make it pythonic

    addpower;set("name","power monitor");set("x",0);→addpower(name="power monitor",x=0)

  2. Provides utility functions such as active instance management get_fdtd_instance() and GPU acceleration GPU_on().

  3. Provide a utility function library for design of Diffractive Optical Neural Networkdonn.py

The Lumerpy package has been released on PyPI, so you can easily install it using the following command: pip install lumerpy

To use this package, you must have Lumerical installed and obtain the Lumerical GUI License authorization. The default location of the lumapi (officially provided API) is: C:\Program Files\Lumerical\v241\api\python.

For a quick start, you can run the command lumerpy.console(globals()) in the Python Console.

Official Lumerical Python API overview: Lumerical

Github: lumerpy

License: MIT

More detailed information will be updated later. Current version of the README file: 1.4


一个基于光学仿真软件Lumerical官方Python API二次包装的Python库,以便于在更复杂情况下使用。

主要内容包括:

  1. 将Lumerical脚本语言风格二次包装为Python语言风格

    addpower;set("name","power monitor");set("x",0);→addpower(name="power monitor",x=0)

  2. 提供了如活动实例管理 get_fdtd_instance() GPU加速 GPU_on() 等实用函数

  3. 提供了用于衍射光学神经网络设计的实用函数库donn.py

Lumerpy已发布至pypi,故可通过运行命令pip install lumerpy便捷安装

使用Lumerpy前,必须先正确安装Lumerical并且获得Lumerical GUI License授权。默认的lumapi(官方提供的api)地址为:C:\Program Files\Lumerical\v241\api\python

一个简单的快速开始示例是,你可以在Python Console中运行输入命令lumerpy.console(globals())

Lumerical 官方 Python API 概览: Lumerical

Github 地址: lumerpy

License: MIT

更多的说明信息会在之后更新,README 文件当前版本:1.4

Metadata

Release files for lumerpy 1.6.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lumerpy 1.6.4
File Size Uploaded Provenance
lumerpy-1.6.4.tar.gz 348.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for lumerpy 1.6.4
File Interpreter ABI Platform
lumerpy-1.6.4-py3-none-any.whl Python 3 none any Details

Total release size: 707.2 kB

Release files / lumerpy-1.6.4.tar.gz

Download URL lumerpy-1.6.4.tar.gz
Size 348.8 kB
Tags Source
SHA-256 checksum
How to use checksums
cc6e84da85c92ee90d7efd6daa4d7c462730c572220f76a1662b7a4d0e82aaa9
BLAKE2b-256 checksum
How to use checksums
4a7d7c10efab8dbe8de75aa9d2a8edb949f24f01a3681ce588064cf552ce6f75
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.9.4

Release files / lumerpy-1.6.4-py3-none-any.whl

Download URL lumerpy-1.6.4-py3-none-any.whl
Size 358.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
725e28d39758617065028b6c4e56f63932809a37f0b235ddd132c26036be5a70
BLAKE2b-256 checksum
How to use checksums
fa068e2a40ba58ef7a3a9ea87f86fa7b1aaf7a9bfeabab8654c2ec67726b00ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.9.4

Security for lumerpy 1.6.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page