LumAPI 1.0.1__tar.gz → 1.0.2__tar.gz

lumapi-1.0.2/LumAPI/config.json

@@ -0,0 +1,4 @@
+{
+    "lumerical_path": "D:\\Program Files\\Lumerical",
+    "version": "v241"
+}

{lumapi-1.0.1 → lumapi-1.0.2}/LumAPI/lumapi.py

@@ -489,104 +489,136 @@ def RorySommerfeld_Vector(lamb, x_near, y_near, E_near_x, E_near_y, x_far, y_far
     return E_far, E_far_x, E_far_y, E_far_z
 
 
-class lumapi:
+class lumerical:
     def __init__(self, lumerical_path='', version='', config_path=CONFIG_PATH):
         self.config_path = config_path
-        
-        # 如果没有提供路径，尝试从配置文件加载
-        if not lumerical_path:
-            try:
-                with open(self.config_path, 'r') as f:
-                    config = json.load(f)
-                lumerical_path = config.get('lumerical_path')
-                version = config.get('version')
-                
-                if not lumerical_path:
-                    raise ValueError("配置文件中缺少lumerical_path字段")
-                    
-            except Exception as e:
-                raise ValueError(f"配置文件读取失败: {str(e)}")
-        
-        # 验证路径
-        self.lumapi = validate_path(lumerical_path, version)
-        
-        # 检测路径是否有效
-        if not self.lumapi:
-            raise ValueError(f"错误：Lumerical路径无效，请检查路径{lumerical_path}和版本{version}")
-        
+        self.lumapi = None
         self.lumerical_path = lumerical_path
         self.version = version
-
-    def FDTD(self, filename=None, key = None, hide = False, serverArgs = {}, remoteArgs = {}, **kwargs):
+        
+        # 尝试加载配置
+        self._load_config()
+
+    def _load_config(self):
+        """内部方法：尝试从参数或配置文件加载 lumapi"""
+        try:
+            path = self.lumerical_path
+            ver = self.version
+            
+            # 如果初始化时没给路径，尝试读配置
+            if not path:
+                if os.path.exists(self.config_path):
+                    with open(self.config_path, 'r', encoding='utf-8') as f:
+                        config = json.load(f)
+                    path = config.get('lumerical_path')
+                    ver = config.get('version')
+            
+            if path:
+                self.lumapi = validate_path(path, ver)
+                self.lumerical_path = path
+                self.version = ver
+        except Exception:
+            self.lumapi = None
+
+    def _check_config_and_prompt(self):
+        """核心逻辑：检查配置状态，若无效则引导用户使用 LumAPI 命令"""
+        if self.lumapi is None:
+            print("\n" + "*" * 60)
+            print("【配置错误】未检测到有效的 Lumerical 环境。")
+            print("原因可能是：")
+            print("1. 尚未进行初始化配置。")
+            print("2. 配置文件 config.json 损坏或路径已失效。")
+            print("\n请在终端执行以下命令进行配置：")
+            print("    LumAPI")
+            print("或者使用命令行配置程序：")
+            print("    LumAPI_CLI")
+            print("*" * 60 + "\n")
+            # 退出程序或抛出异常，防止后续调用崩溃
+            sys.exit(1)
+
+    def FDTD(self, filename=None, key=None, hide=False, serverArgs={}, remoteArgs={}, **kwargs):
+        self._check_config_and_prompt()
         return FDTD(self.lumapi, filename, key, hide, serverArgs, remoteArgs, **kwargs)
     
-    def MODE(self, filename=None, key = None, hide = False, serverArgs = {}, remoteArgs = {}, **kwargs):
+    def MODE(self, filename=None, key=None, hide=False, serverArgs={}, remoteArgs={}, **kwargs):
+        self._check_config_and_prompt()
         return MODE(self.lumapi, filename, key, hide, serverArgs, remoteArgs, **kwargs)
     
-    def DEVICE(self, filename=None, key = None, hide = False, serverArgs = {}, remoteArgs = {}, **kwargs):
-        return MODE(self.lumapi, filename, key, hide, serverArgs, remoteArgs, **kwargs)
+    def DEVICE(self, filename=None, key=None, hide=False, serverArgs={}, remoteArgs={}, **kwargs):
+        self._check_config_and_prompt()
+        return DEVICE(self.lumapi, filename, key, hide, serverArgs, remoteArgs, **kwargs)
     
-    def INTERCONNECT(self, filename=None, key = None, hide = False, serverArgs = {}, remoteArgs = {}, **kwargs):
-        return MODE(self.lumapi, filename, key, hide, serverArgs, remoteArgs, **kwargs)
-    
-class FDTD():
-    def __init__(self, lumapi, filename=None, key = None, hide = False, serverArgs = {}, remoteArgs = {}, **kwargs):
-        self.lumapi = lumapi
-        self.filename = filename
-        
-        self.fdtd = lumapi.FDTD(filename, key, hide, serverArgs, remoteArgs, **kwargs)
+    def INTERCONNECT(self, filename=None, key=None, hide=False, serverArgs={}, remoteArgs={}, **kwargs):
+        self._check_config_and_prompt()
+        return INTERCONNECT(self.lumapi, filename, key, hide, serverArgs, remoteArgs, **kwargs)
+
+class LumFuncBase:
+    """Lumerical 功能基类，处理通用的 API 转发和参数预处理"""
+    def __init__(self, target_handle):
+        # 隐藏内部句柄，避免与转发逻辑冲突
+        self._handle = target_handle
+
+    def _process_arg(self, arg):
+        """
+        核心预处理逻辑：
+        1. 整型 ndarray -> 浮点型
+        2. 一维 ndarray (len > 1) -> 二维 [[...]]
+        """
+        if isinstance(arg, np.ndarray):
+            # 规则 1: 检查是否为整型数组并转换
+            if np.issubdtype(arg.dtype, np.integer):
+                arg = arg.astype(float)
+            
+            # 规则 2: 检查一维数组且长度不为 1，进行升维
+            if arg.ndim == 1 and arg.shape[0] != 1:
+                arg = arg[np.newaxis, :]
+        return arg
 
     def __getattr__(self, name):
-        '''
-        将原本函数转发回去
-        '''
-        return getattr(self.fdtd, name)
-    
-class MODE():
-    def __init__(self, lumapi, filename=None, key = None, hide = False, serverArgs = {}, remoteArgs = {}, **kwargs):
-        self.lumapi = lumapi
-        self.filename = filename
+        # 从 Lumerical 原始句柄中获取属性或方法
+        attr = getattr(self._handle, name)
         
-        if not filename:
-            self.mode = lumapi.MODE()
-        else:
-            self.mode = lumapi.MODE(filename, key, hide, serverArgs, remoteArgs, **kwargs)
-
-    def __getattr__(self, name):
-        '''
-        将原本函数转发回去
-        '''
-        return getattr(self.mode, name)
+        # 如果不是可调用对象（如变量、常量），直接返回
+        if not callable(attr):
+            return attr
+
+        # 如果是方法，返回包装函数进行参数拦截处理
+        def wrapper(*args, **kwargs):
+            # 处理位置参数
+            new_args = tuple(self._process_arg(arg) for arg in args)
+            # 处理关键字参数
+            new_kwargs = {k: self._process_arg(v) for k, v in kwargs.items()}
+            
+            # 调用原始 API 并返回结果
+            return attr(*new_args, **new_kwargs)
+            
+        return wrapper
     
-class DEVICE():
-    def __init__(self, lumapi, filename=None, key = None, hide = False, serverArgs = {}, remoteArgs = {}, **kwargs):
-        self.lumapi = lumapi
+class FDTD(LumFuncBase):
+    def __init__(self, lumapi, filename=None, key=None, hide=False, serverArgs={}, remoteArgs={}, **kwargs):
+        handle = lumapi.FDTD(filename, key, hide, serverArgs, remoteArgs, **kwargs)
+        super().__init__(handle)
         self.filename = filename
-        
-        if not filename:
-            self.device = lumapi.DEVICE()
-        else:
-            self.device = lumapi.DEVICE(filename, key, hide, serverArgs, remoteArgs, **kwargs)
 
-    def __getattr__(self, name):
-        '''
-        将原本函数转发回去
-        '''
-        return getattr(self.device, name)
-    
-class INTERCONNECT():
-    def __init__(self, lumapi, filename=None, key = None, hide = False, serverArgs = {}, remoteArgs = {}, **kwargs):
-        self.lumapi = lumapi
+class MODE(LumFuncBase):
+    def __init__(self, lumapi, filename=None, key=None, hide=False, serverArgs={}, remoteArgs={}, **kwargs):
+        handle = lumapi.MODE(filename, key, hide, serverArgs, remoteArgs, **kwargs)
+        super().__init__(handle)
         self.filename = filename
-        
-        self.interconnect = lumapi.INTERCONNECT(filename, key, hide, serverArgs, remoteArgs, **kwargs)
 
-    def __getattr__(self, name):
-        '''
-        将原本函数转发回去
-        '''
-        return getattr(self.interconnect, name)
+class DEVICE(LumFuncBase):
+    def __init__(self, lumapi, filename=None, key=None, hide=False, serverArgs={}, remoteArgs={}, **kwargs):
+        handle = lumapi.DEVICE(filename, key, hide, serverArgs, remoteArgs, **kwargs)
+        super().__init__(handle)
+        self.filename = filename
 
+class INTERCONNECT(LumFuncBase):
+    def __init__(self, lumapi, filename=None, key=None, hide=False, serverArgs={}, remoteArgs={}, **kwargs):
+        handle = lumapi.INTERCONNECT(filename, key, hide, serverArgs, remoteArgs, **kwargs)
+        super().__init__(handle)
+        self.filename = filename
+    
+lumapi = lumerical()
 
 if __name__ == '__main__':
     um = 1e-6

{lumapi-1.0.1 → lumapi-1.0.2}/LumAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: LumAPI
-Version: 1.0.1
+Version: 1.0.2
 Summary: Lumerical Python API 自动化配置工具
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
@@ -25,6 +25,57 @@ Dynamic: license-file
 
 ## 🚀 快速开始
 
+## 📦 pip安装(推荐)
+
+### 1. 库文件下载
+通过运行以下命令安装`LumAPI`库
+```bash
+pip install LumAPI
+```
+### 2. 配置lumerical路径
+在安装完库后运行下面的命令即可打开lumerical路径配置页面
+图形界面配置：
+```bash
+LumAPI
+```
+命令行配置：
+```bash
+LumAPI_CLI
+```
+### 3. 使用
+通过下述代码即可调用 Lumerical API：
+```python
+from LumAPI import *
+
+filename = 'simulation.fsp'
+fdtd = lumapi.FDTD(filename)
+fdtd.close()
+```
+或者不进行lumerical配置，直接传入lumerical路径：
+```python
+from LumAPI import *
+lumerical_path = 'C:/Program Files/Lumerical'
+version = 'v241'
+fdtd = lumerical(lumerical_path=lumerical_path, version=version).FDTD(filename)
+fdtd.close()
+```
+或者传入config.json路径：
+```python
+from LumAPI import *
+config_path = './config.json'
+fdtd = lumerical(config_path=config_path).FDTD(filename)
+fdtd.close()
+```
+其中config.json文件内容如下：
+```python
+{
+    "lumerical_path": "C:\\Program Files\\Lumerical",
+    "version": "v241"
+}
+```
+
+## 📦 打包程序安装
+
 ### 1. 获取程序
 请前往 [Releases 页面](releases) 下载适配您操作系统（Windows/Linux）及架构（AMD64/ARM64）的预编译程序。`LumAPI_GUI`为带图形界面版本的配置程序，`LumAPI_CLI`为无图形界面版本的命令行配置工具，二者选择其一即可。
 
@@ -66,7 +117,7 @@ Dynamic: license-file
 
 **代码示例：**
 ```python
-import LumAPI.lumapi as lumapi  # 根据实际导出结构调整导入路径
+from LumAPI import lumapi
 
 # 定义基础参数
 um = 1e-6

{lumapi-1.0.1 → lumapi-1.0.2}/LumAPI.egg-info/SOURCES.txt

@@ -11,4 +11,5 @@ LumAPI.egg-info/SOURCES.txt
 LumAPI.egg-info/dependency_links.txt
 LumAPI.egg-info/entry_points.txt
 LumAPI.egg-info/requires.txt
-LumAPI.egg-info/top_level.txt
+LumAPI.egg-info/top_level.txt
+test/test.py

{lumapi-1.0.1 → lumapi-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: LumAPI
-Version: 1.0.1
+Version: 1.0.2
 Summary: Lumerical Python API 自动化配置工具
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
@@ -25,6 +25,57 @@ Dynamic: license-file
 
 ## 🚀 快速开始
 
+## 📦 pip安装(推荐)
+
+### 1. 库文件下载
+通过运行以下命令安装`LumAPI`库
+```bash
+pip install LumAPI
+```
+### 2. 配置lumerical路径
+在安装完库后运行下面的命令即可打开lumerical路径配置页面
+图形界面配置：
+```bash
+LumAPI
+```
+命令行配置：
+```bash
+LumAPI_CLI
+```
+### 3. 使用
+通过下述代码即可调用 Lumerical API：
+```python
+from LumAPI import *
+
+filename = 'simulation.fsp'
+fdtd = lumapi.FDTD(filename)
+fdtd.close()
+```
+或者不进行lumerical配置，直接传入lumerical路径：
+```python
+from LumAPI import *
+lumerical_path = 'C:/Program Files/Lumerical'
+version = 'v241'
+fdtd = lumerical(lumerical_path=lumerical_path, version=version).FDTD(filename)
+fdtd.close()
+```
+或者传入config.json路径：
+```python
+from LumAPI import *
+config_path = './config.json'
+fdtd = lumerical(config_path=config_path).FDTD(filename)
+fdtd.close()
+```
+其中config.json文件内容如下：
+```python
+{
+    "lumerical_path": "C:\\Program Files\\Lumerical",
+    "version": "v241"
+}
+```
+
+## 📦 打包程序安装
+
 ### 1. 获取程序
 请前往 [Releases 页面](releases) 下载适配您操作系统（Windows/Linux）及架构（AMD64/ARM64）的预编译程序。`LumAPI_GUI`为带图形界面版本的配置程序，`LumAPI_CLI`为无图形界面版本的命令行配置工具，二者选择其一即可。
 
@@ -66,7 +117,7 @@ Dynamic: license-file
 
 **代码示例：**
 ```python
-import LumAPI.lumapi as lumapi  # 根据实际导出结构调整导入路径
+from LumAPI import lumapi
 
 # 定义基础参数
 um = 1e-6

{lumapi-1.0.1 → lumapi-1.0.2}/README.md

@@ -11,6 +11,57 @@
 
 ## 🚀 快速开始
 
+## 📦 pip安装(推荐)
+
+### 1. 库文件下载
+通过运行以下命令安装`LumAPI`库
+```bash
+pip install LumAPI
+```
+### 2. 配置lumerical路径
+在安装完库后运行下面的命令即可打开lumerical路径配置页面
+图形界面配置：
+```bash
+LumAPI
+```
+命令行配置：
+```bash
+LumAPI_CLI
+```
+### 3. 使用
+通过下述代码即可调用 Lumerical API：
+```python
+from LumAPI import *
+
+filename = 'simulation.fsp'
+fdtd = lumapi.FDTD(filename)
+fdtd.close()
+```
+或者不进行lumerical配置，直接传入lumerical路径：
+```python
+from LumAPI import *
+lumerical_path = 'C:/Program Files/Lumerical'
+version = 'v241'
+fdtd = lumerical(lumerical_path=lumerical_path, version=version).FDTD(filename)
+fdtd.close()
+```
+或者传入config.json路径：
+```python
+from LumAPI import *
+config_path = './config.json'
+fdtd = lumerical(config_path=config_path).FDTD(filename)
+fdtd.close()
+```
+其中config.json文件内容如下：
+```python
+{
+    "lumerical_path": "C:\\Program Files\\Lumerical",
+    "version": "v241"
+}
+```
+
+## 📦 打包程序安装
+
 ### 1. 获取程序
 请前往 [Releases 页面](releases) 下载适配您操作系统（Windows/Linux）及架构（AMD64/ARM64）的预编译程序。`LumAPI_GUI`为带图形界面版本的配置程序，`LumAPI_CLI`为无图形界面版本的命令行配置工具，二者选择其一即可。
 
@@ -52,7 +103,7 @@
 
 **代码示例：**
 ```python
-import LumAPI.lumapi as lumapi  # 根据实际导出结构调整导入路径
+from LumAPI import lumapi
 
 # 定义基础参数
 um = 1e-6

{lumapi-1.0.1 → lumapi-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "LumAPI"
-version = "1.0.1"
+version = "1.0.2"
 description = "Lumerical Python API 自动化配置工具"
 readme = "README.md"
 requires-python = ">=3.7"

lumapi-1.0.2/test/test.py

@@ -0,0 +1,13 @@
+from LumAPI import *
+
+fdtd = lumapi.FDTD()
+
+
+
+
+
+
+
+
+
+