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.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lumerpy-1.6.4.tar.gz (348.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lumerpy-1.6.4-py3-none-any.whl (358.4 kB view details)

Uploaded Python 3

File details

Details for the file lumerpy-1.6.4.tar.gz.

File metadata

  • Download URL: lumerpy-1.6.4.tar.gz
  • Upload date:
  • Size: 348.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.4

File hashes

Hashes for lumerpy-1.6.4.tar.gz
Algorithm Hash digest
SHA256 cc6e84da85c92ee90d7efd6daa4d7c462730c572220f76a1662b7a4d0e82aaa9
MD5 9131689d414129654eae35925e0b44d3
BLAKE2b-256 4a7d7c10efab8dbe8de75aa9d2a8edb949f24f01a3681ce588064cf552ce6f75

See more details on using hashes here.

File details

Details for the file lumerpy-1.6.4-py3-none-any.whl.

File metadata

  • Download URL: lumerpy-1.6.4-py3-none-any.whl
  • Upload date:
  • Size: 358.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.4

File hashes

Hashes for lumerpy-1.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 725e28d39758617065028b6c4e56f63932809a37f0b235ddd132c26036be5a70
MD5 22746475c0f8b60803aca60759e834ea
BLAKE2b-256 fa068e2a40ba58ef7a3a9ea87f86fa7b1aaf7a9bfeabab8654c2ec67726b00ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page