logqbit 0.2.0__tar.gz

logqbit-0.2.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.3
+Name: logqbit
+Version: 0.2.0
+Summary: Simple data logger and live plotter for lab-scale experiments.
+Requires-Dist: labcodes>=1.0.4
+Requires-Dist: numpy>=2.3.3
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: pyarrow>=21.0.0
+Requires-Dist: pyqtgraph>=0.13.7
+Requires-Dist: pyside6>=6.9.3
+Requires-Dist: ruamel-yaml>=0.18.15
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: pylabrad>=0.98.3 ; extra == 'labrad'
+Requires-Python: >=3.13
+Project-URL: Homepage, https://github.com/Qiujv/logqbit
+Provides-Extra: labrad
+Description-Content-Type: text/markdown
+
+# LogQbit
+
+*LogQbit* 是一个轻量且可扩展的实验数据记录工具包。
+它最初用于记录 量子比特（qubit）实验测量数据，但凭借灵活的数据格式和实时可视化功能，同样适用于 任意中小规模（≤MB级）实验数据 的采集与管理。
+
+*LogQbit* is a lightweight and extensible data logging toolkit for lab-scale experiments.
+It was originally developed for recording quantum qubit measurement data, 
+but its flexible format and real-time visualization tools make it suitable for any small to medium (≤MB-level) experimental dataset.
+
+通过使用 `logqbit`，你可以：
+
+- 以最少的样板代码记录结构化实验数据；
+
+- 使用集成的实时绘图工具可视化数据流；
+
+- 通过交互式日志浏览器查看与分析记录的数据。
+
+With `logqbit`, you can:
+
+- Record structured experimental data with minimal boilerplate.
+
+- Visualize data streams in real time with an integrated live plotter.
+
+- Browse and analyze logged results through an interactive log browser.
+
+无论是量子比特读出、参数扫描，还是传感器输出记录，
+`logqbit` 都能为你提供一个简洁而可靠的实验数据采集与回溯工作流。
+
+Whether you are monitoring qubit readouts, scanning a parameter sweep, or simply logging sensor outputs, 
+`logqbit` provides a simple and robust workflow for capturing and revisiting your experimental data.
+
+## 安装 Installation
+
+从 PyPI 安装 / Install from PyPI:
+
+```bash
+pip install logqbit
+```
+
+## 命令行工具 Command-Line Tools
+
+安装后，以下命令可用：
+
+After installation, the following commands are available:
+
+- `logqbit-browser [directory]` - 启动交互式日志浏览器 GUI / Launch the interactive log browser GUI
+- `logqbit-live-plotter` - 启动实时绘图窗口 / Launch the live plotting window
+- `logqbit browser-demo` - 创建示例数据并启动浏览器 / Create example data and launch browser
+- `logqbit copy-template <name>` - 复制迁移/工具模板到工作目录 / Copy migration/utility templates to your working directory
+- `logqbit shortcuts` - 在桌面创建带自定义图标的快捷方式 / Create desktop shortcuts with custom icons
+
+### 快速体验 Quick Demo
+
+想快速体验 logqbit browser 的功能？运行以下命令：
+
+Want to quickly experience logqbit browser? Run:
+
+```bash
+logqbit browser-demo
+```
+
+这将创建示例数据并自动启动浏览器：
+
+This will create example data and automatically launch the browser:
+
+- `logqbit_example/` - 包含 3 个示例日志文件夹 / Contains 3 example log folders
+  - **示例 0** - 线性关系：`y = 2x + 1` 和 `z = x²` / Linear relationship: `y = 2x + 1` and `z = x²`
+  - **示例 1** - 带噪声的正弦信号 / Noisy sinusoidal signal
+  - **示例 2** - 2D 参数扫描（共振模拟）/ 2D parameter scan (resonance simulation)
+
+浏览器将自动打开并显示示例数据。
+
+The browser will automatically open and display the example data.
+
+### 从 LabRAD 迁移数据 Data Migration from LabRAD
+
+如果你有 LabRAD 格式的现有数据，可以轻松迁移：
+
+If you have existing data in LabRAD format, you can easily migrate it:
+
+```bash
+# 复制迁移模板 / Copy the migration template
+logqbit copy-template move_from_labrad
+
+# 编辑 move_from_labrad.py 设置路径 / Edit move_from_labrad.py to set your paths
+# 然后运行 / Then run it
+python move_from_labrad.py
+```
+
+详细说明请参阅 [迁移指南](docs/migration_guide.md)。
+
+See [Migration Guide](docs/migration_guide.md) for detailed instructions.
+
+### 创建桌面快捷方式 Create Desktop Shortcuts
+
+在桌面创建 LogQbit Browser 和 Live Plotter 的快捷方式（带自定义图标）：
+
+Create desktop shortcuts for LogQbit Browser and Live Plotter with custom icons:
+
+```bash
+# 在桌面创建快捷方式 / Create shortcuts on desktop
+logqbit shortcuts
+
+# 在指定目录创建快捷方式 / Create shortcuts in a specific directory
+logqbit shortcuts -o "C:\MyShortcuts"
+```
+
+这将创建以下快捷方式：
+
+This will create the following shortcuts:
+
+- **LogQbit Browser.lnk** - 日志浏览器快捷方式 / Log browser shortcut
+- **LogQbit Live Plotter.lnk** - 实时绘图工具快捷方式 / Live plotter shortcut
+
+每个快捷方式都配有对应的自定义图标。
+
+Each shortcut comes with its corresponding custom icon.
+
+## 文档 Documentation
+
+- [首页 index](docs/index.md)
+- [迁移指南 Migration Guide](docs/migration_guide.md) - 从 LabRAD 迁移数据 / Migrate data from LabRAD format
+
+## 快速开始 Quick Start
+
+### 基本用法 Basic Usage
+
+```python
+from pathlib import Path
+from logqbit.logfolder import LogFolder
+
+# 创建项目文件夹 / Create project folder
+project_folder = Path('test')
+project_folder.mkdir(exist_ok=True)
+
+# 创建新的日志文件夹 / Create a new log folder
+lf = LogFolder.new(project_folder)
+
+# 添加数据行 / Add data rows
+lf.add_row(x=1.5, y=2.0)
+lf.add_row(x=233, y=[1, 3, 5])
+
+# 访问数据 / Access data
+print(lf.df)
+
+# [可选] 设置元数据 / [Optional] Set metadata
+lf.meta.title = "My Experiment"
+lf.meta.star = 1
+lf.meta.plot_axes = ["x"]
+
+# [可选] 添加常量配置 / [Optional] Add constant configuration
+lf.const["temperature"] = "300 K"
+lf.const["description"] = "Test measurement"
+```
+
+### API 说明 API Reference
+
+**LogFolder 主要属性和方法 Main Attributes and Methods:**
+
+- `lf.df` - 获取完整数据帧 / Get full dataframe
+- `lf.meta` - 元数据（标题、星标、标签等）/ Metadata (title, star, tags, etc.)
+- `lf.const` - 常量配置（实验参数等）/ Constant configuration (experiment parameters, etc.)
+- `lf.add_row(**kwargs)` - 添加数据行 / Add data row
+- `lf.flush()` - 强制保存数据 / Force save data

logqbit-0.2.0/README.md

@@ -0,0 +1,164 @@
+# LogQbit
+
+*LogQbit* 是一个轻量且可扩展的实验数据记录工具包。
+它最初用于记录 量子比特（qubit）实验测量数据，但凭借灵活的数据格式和实时可视化功能，同样适用于 任意中小规模（≤MB级）实验数据 的采集与管理。
+
+*LogQbit* is a lightweight and extensible data logging toolkit for lab-scale experiments.
+It was originally developed for recording quantum qubit measurement data, 
+but its flexible format and real-time visualization tools make it suitable for any small to medium (≤MB-level) experimental dataset.
+
+通过使用 `logqbit`，你可以：
+
+- 以最少的样板代码记录结构化实验数据；
+
+- 使用集成的实时绘图工具可视化数据流；
+
+- 通过交互式日志浏览器查看与分析记录的数据。
+
+With `logqbit`, you can:
+
+- Record structured experimental data with minimal boilerplate.
+
+- Visualize data streams in real time with an integrated live plotter.
+
+- Browse and analyze logged results through an interactive log browser.
+
+无论是量子比特读出、参数扫描，还是传感器输出记录，
+`logqbit` 都能为你提供一个简洁而可靠的实验数据采集与回溯工作流。
+
+Whether you are monitoring qubit readouts, scanning a parameter sweep, or simply logging sensor outputs, 
+`logqbit` provides a simple and robust workflow for capturing and revisiting your experimental data.
+
+## 安装 Installation
+
+从 PyPI 安装 / Install from PyPI:
+
+```bash
+pip install logqbit
+```
+
+## 命令行工具 Command-Line Tools
+
+安装后，以下命令可用：
+
+After installation, the following commands are available:
+
+- `logqbit-browser [directory]` - 启动交互式日志浏览器 GUI / Launch the interactive log browser GUI
+- `logqbit-live-plotter` - 启动实时绘图窗口 / Launch the live plotting window
+- `logqbit browser-demo` - 创建示例数据并启动浏览器 / Create example data and launch browser
+- `logqbit copy-template <name>` - 复制迁移/工具模板到工作目录 / Copy migration/utility templates to your working directory
+- `logqbit shortcuts` - 在桌面创建带自定义图标的快捷方式 / Create desktop shortcuts with custom icons
+
+### 快速体验 Quick Demo
+
+想快速体验 logqbit browser 的功能？运行以下命令：
+
+Want to quickly experience logqbit browser? Run:
+
+```bash
+logqbit browser-demo
+```
+
+这将创建示例数据并自动启动浏览器：
+
+This will create example data and automatically launch the browser:
+
+- `logqbit_example/` - 包含 3 个示例日志文件夹 / Contains 3 example log folders
+  - **示例 0** - 线性关系：`y = 2x + 1` 和 `z = x²` / Linear relationship: `y = 2x + 1` and `z = x²`
+  - **示例 1** - 带噪声的正弦信号 / Noisy sinusoidal signal
+  - **示例 2** - 2D 参数扫描（共振模拟）/ 2D parameter scan (resonance simulation)
+
+浏览器将自动打开并显示示例数据。
+
+The browser will automatically open and display the example data.
+
+### 从 LabRAD 迁移数据 Data Migration from LabRAD
+
+如果你有 LabRAD 格式的现有数据，可以轻松迁移：
+
+If you have existing data in LabRAD format, you can easily migrate it:
+
+```bash
+# 复制迁移模板 / Copy the migration template
+logqbit copy-template move_from_labrad
+
+# 编辑 move_from_labrad.py 设置路径 / Edit move_from_labrad.py to set your paths
+# 然后运行 / Then run it
+python move_from_labrad.py
+```
+
+详细说明请参阅 [迁移指南](docs/migration_guide.md)。
+
+See [Migration Guide](docs/migration_guide.md) for detailed instructions.
+
+### 创建桌面快捷方式 Create Desktop Shortcuts
+
+在桌面创建 LogQbit Browser 和 Live Plotter 的快捷方式（带自定义图标）：
+
+Create desktop shortcuts for LogQbit Browser and Live Plotter with custom icons:
+
+```bash
+# 在桌面创建快捷方式 / Create shortcuts on desktop
+logqbit shortcuts
+
+# 在指定目录创建快捷方式 / Create shortcuts in a specific directory
+logqbit shortcuts -o "C:\MyShortcuts"
+```
+
+这将创建以下快捷方式：
+
+This will create the following shortcuts:
+
+- **LogQbit Browser.lnk** - 日志浏览器快捷方式 / Log browser shortcut
+- **LogQbit Live Plotter.lnk** - 实时绘图工具快捷方式 / Live plotter shortcut
+
+每个快捷方式都配有对应的自定义图标。
+
+Each shortcut comes with its corresponding custom icon.
+
+## 文档 Documentation
+
+- [首页 index](docs/index.md)
+- [迁移指南 Migration Guide](docs/migration_guide.md) - 从 LabRAD 迁移数据 / Migrate data from LabRAD format
+
+## 快速开始 Quick Start
+
+### 基本用法 Basic Usage
+
+```python
+from pathlib import Path
+from logqbit.logfolder import LogFolder
+
+# 创建项目文件夹 / Create project folder
+project_folder = Path('test')
+project_folder.mkdir(exist_ok=True)
+
+# 创建新的日志文件夹 / Create a new log folder
+lf = LogFolder.new(project_folder)
+
+# 添加数据行 / Add data rows
+lf.add_row(x=1.5, y=2.0)
+lf.add_row(x=233, y=[1, 3, 5])
+
+# 访问数据 / Access data
+print(lf.df)
+
+# [可选] 设置元数据 / [Optional] Set metadata
+lf.meta.title = "My Experiment"
+lf.meta.star = 1
+lf.meta.plot_axes = ["x"]
+
+# [可选] 添加常量配置 / [Optional] Add constant configuration
+lf.const["temperature"] = "300 K"
+lf.const["description"] = "Test measurement"
+```
+
+### API 说明 API Reference
+
+**LogFolder 主要属性和方法 Main Attributes and Methods:**
+
+- `lf.df` - 获取完整数据帧 / Get full dataframe
+- `lf.meta` - 元数据（标题、星标、标签等）/ Metadata (title, star, tags, etc.)
+- `lf.const` - 常量配置（实验参数等）/ Constant configuration (experiment parameters, etc.)
+- `lf.add_row(**kwargs)` - 添加数据行 / Add data row
+- `lf.flush()` - 强制保存数据 / Force save data

logqbit-0.2.0/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "logqbit"
+version = "0.2.0"
+description = "Simple data logger and live plotter for lab-scale experiments."
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "labcodes>=1.0.4",
+    "numpy>=2.3.3",
+    "pandas>=2.3.3",
+    "pyarrow>=21.0.0",
+    "pyqtgraph>=0.13.7",
+    "pyside6>=6.9.3",
+    "ruamel-yaml>=0.18.15",
+    "tqdm>=4.67.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/Qiujv/logqbit"
+
+[project.scripts]
+logqbit = "logqbit.cli:main"
+
+[project.gui-scripts]
+logqbit-live-plotter = "logqbit.live_plotter:main"
+logqbit-browser = "logqbit.browser:main"
+
+[project.optional-dependencies]
+labrad = [
+    "pylabrad>=0.98.3",
+]
+
+[build-system]
+requires = ["uv_build>=0.8.0,<0.9.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "ipykernel>=6.30.1",
+    "ipywidgets>=8.1.7",
+    "matplotlib>=3.10.7",
+    "pytest>=8.4.2",
+    "pytest-cov>=7.0.0",
+]

logqbit-0.2.0/src/logqbit/assets/browser.svg

@@ -0,0 +1,40 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 512 512">
+    <defs>
+        <style>
+            .cls-1 {
+                fill: #ffca4f;
+            }
+
+            .cls-2 {
+                fill: #ffd97d;
+            }
+
+            .cls-3 {
+                fill: #ffe9b1;
+            }
+
+            .cls-4 {
+                fill: #a56ad4;
+            }
+
+            .cls-5 {
+                fill: #fb9423;
+            }
+
+            .cls-6 {
+                fill: #6cb64e;
+            }
+        </style>
+    </defs>
+    <rect class="cls-1" x="90.13" y="101.9" width="324" height="187.2" rx="25" />
+    <rect class="cls-2" x="72.13" y="166.65" width="360" height="187.2" rx="25" />
+    <rect class="cls-3" x="54.13" y="235.2" width="396" height="201.6" rx="25" />
+    <path class="cls-4"
+        d="M108.7,266.3a27.54,27.54,0,0,1-27.5-27.5V226.2a22.52,22.52,0,0,1,22.5-22.5h89.6a22.52,22.52,0,0,1,22.5,22.5v12.6a27.54,27.54,0,0,1-27.5,27.5Z" />
+    <path class="cls-3"
+        d="M193.3,206.2a20,20,0,0,1,20,20v12.6a25,25,0,0,1-25,25H108.7a25,25,0,0,1-25-25V226.2a20,20,0,0,1,20-20h89.6m0-5H103.7a25,25,0,0,0-25,25v12.6a30,30,0,0,0,30,30h79.6a30,30,0,0,0,30-30V226.2a25,25,0,0,0-25-25Z" />
+    <rect class="cls-5" x="167.45" y="136.7" width="134.6" height="62.6" rx="27.5" />
+    <path class="cls-2"
+        d="M274.55,139.2a25,25,0,0,1,25,25v7.6a25,25,0,0,1-25,25H195a25,25,0,0,1-25-25v-7.6a25,25,0,0,1,25-25h79.6m0-5H195a30,30,0,0,0-30,30v7.6a30,30,0,0,0,30,30h79.6a30,30,0,0,0,30-30v-7.6a30,30,0,0,0-30-30Z" />
+    <rect class="cls-6" x="256.2" y="73.2" width="129.6" height="57.6" rx="25" />
+</svg>

logqbit-0.2.0/src/logqbit/assets/live_plotter.svg

@@ -0,0 +1,15 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 512 512">
+  <defs>
+    <marker id="arrow" viewBox="0 0 10 10" refX="5" refY="5" markerWidth="3" markerHeight="3"
+      orient="auto-start-reverse">
+      <path d="M 0 0 L 10 5 L 0 10 z" fill="#2DB84D" />
+    </marker>
+  </defs>
+  <g stroke="#2DB84D" stroke-width="28" stroke-linecap="round" stroke-linejoin="round" fill="none">
+    <path d="M 96 432 L 96 96" />
+    <path d="M 96 432 L 416 432" />
+  </g>
+  <polyline points="136,360 220,220 300,300 396,168" fill="none" stroke="#2DB84D" stroke-width="32"
+    stroke-linecap="round" stroke-linejoin="round" marker-end="url(#arrow)" />
+  <circle cx="300" cy="360" r="20" fill="#2DB84D" />
+</svg>