pyacquisition 0.1.0__tar.gz

pyacquisition-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Environment variables
+.env
+
+data/

pyacquisition-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

pyacquisition-0.1.0/.readthedocs.yml

@@ -0,0 +1,28 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+  jobs:
+    create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+      - uv venv
+    install:
+      - uv pip compile pyproject.toml -o requirements.txt
+      - uv pip install -r requirements.txt
+    build:
+      html:
+        #- uv run mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html
+        - uv run mkdocs build --site-dir $READTHEDOCS_OUTPUT/html
+      
+mkdocs:
+  # Path to your MkDocs configuration file.
+  configuration: mkdocs.yml

pyacquisition-0.1.0/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

pyacquisition-0.1.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: pyacquisition
+Version: 0.1.0
+Summary: Add your description here
+Project-URL: Homepage, https://github.com/jakeayres/pyacquisition
+Project-URL: Documentation, https://pyacquisition.readthedocs.io
+Project-URL: Repository, https://github.com/jakeayres/pyacquisition.git
+Project-URL: Issues, https://github.com/jakeayres/pyacquisition/issues
+Author-email: jakeayres <jake_ayres@hotmail.co.uk>
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.11.16
+Requires-Dist: asyncio>=3.4.3
+Requires-Dist: dearpygui>=2.0.0
+Requires-Dist: fastapi[standard]>=0.115.12
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: mkdocs-material>=9.6.11
+Requires-Dist: mkdocs>=1.6.1
+Requires-Dist: mkdocstrings[python]>=0.29.1
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pyserial>=3.5
+Requires-Dist: pytest-asyncio>=0.26.0
+Requires-Dist: pytest-mock>=3.14.0
+Requires-Dist: pytest>=8.3.5
+Requires-Dist: pyvisa-py>=0.8.0
+Requires-Dist: pyvisa>=1.15.0
+Requires-Dist: uvicorn>=0.34.1
+Description-Content-Type: text/markdown
+
+# PyAcquisition
+
+A library for the rapid assembly of measurement software for interfacting with scientific instruments.
+
+

pyacquisition-0.1.0/README.md

@@ -0,0 +1,5 @@
+# PyAcquisition
+
+A library for the rapid assembly of measurement software for interfacting with scientific instruments.
+
+

pyacquisition-0.1.0/docs/basics/configuration.md

@@ -0,0 +1,106 @@
+An experiment can be set up in two ways:
+
+**1. Using a `.toml` file**  
+
+This method is ideal if you only need to use the built-in functionality of `pyacquisition`. Simply create a `.toml` file to define your experiment's configuration. The `.toml` file is read using `Experiment.from_config()`, which automatically calls the necessary methods to set up your experiment.
+
+*Advantages:*
+
+- Simple and requires no Python coding.  
+- Access all built-in functionality directly.
+
+**2. Using the `setup()` method**  
+
+This method is for cases where you need custom functionality, such as adding new instruments or tasks. To do this, inherit from `pyacquisition.experiment` and define your custom logic in the `setup()` method. You can define custom instruments and task classes, then import them into your code for use within the `setup()` method.
+
+*Use this method if:*  
+
+- You need to extend the core functionality of `pyacquisition`.  
+- You want to define and integrate custom instruments or tasks.  
+- You want to import and integrate your own code.
+
+## `.toml` File Configuration
+
+The `.toml` file is used to define the configuration for your experiment. Details of the `.toml` syntax can be found [toml.io](https://toml.io/en/).
+
+Below is a breakdown of the sections and parameters available in the file:
+
+## General Parameters
+
+General parameters for the experiment.
+
+| Parameter Name | Description                          | Default Value |
+|----------------|--------------------------------------|---------------|
+| `root_path`    | Root directory for the experiment.   | `.`           |
+
+
+## `[rack]` Section
+
+Configuration of the rack 
+
+| Parameter Name | Description                          | Default Value |
+|----------------|--------------------------------------|---------------|
+| `period`       | Time period for rack operations.     | `0.25`        |
+
+
+## `[instruments]` Section
+
+Software and hardware instruments to configure. 
+
+An example `SoftwareInstrument` is given:
+
+| Insrument Name | Description                          | Example Configuration |
+|----------------|--------------------------------------|---------------|
+| `my_clock`        | Defines the clock instrument.        | `{instrument = "clock"}` |
+
+
+## `[measurements]` Section
+
+Define the instrument methods to poll. The key is the label assigned to the measurement (e.g. 'time', 'voltage', 'temperature'). The value is a dictionary with the following parameters:
+
+| Parameter Name | Description                          | Example Value    |
+|----------------|--------------------------------------|------------------|
+| `instrument`   | The name of the instrument           | `my_clock`       |
+| `method`       | The method to poll                   | `timestamp_ms`   |
+
+!!! Note
+    The value assigned to `instrument` **must** be present as a parameter in the `[instruments]` section. 
+
+
+??? Example
+    ```
+    [measurements]
+    time = {instrument = "clock", method = "timestamp_ms"}
+    voltage = {instrument = "lockin_1", method = "get_x"} 
+    ```
+
+
+## `[data]` Section
+
+| Parameter Name | Description                          | Default Value |
+|----------------|--------------------------------------|---------------|
+| `path`         | Directory for storing data.          | `.`           |
+
+
+## `[api_server]` Section
+
+| Parameter Name         | Description                          | Default Value          |
+|------------------------|--------------------------------------|------------------------|
+| `host`                 | Hostname for the API server.         | `localhost`            |
+| `port`                 | Port for the API server.             | `8005`                 |
+| `allowed_cors_origins` | List of allowed CORS origins.        | `["http://localhost:3000"]` |
+
+
+## `[logging]` Section
+
+| Parameter Name  | Description                          | Default Value |
+|-----------------|--------------------------------------|---------------|
+| `console_level` | Logging level for console output.    | `DEBUG`       |
+| `file_level`    | Logging level for file output.       | `DEBUG`       |
+| `file_name`     | Name of the log file.                | `debug.log`   |
+
+
+
+## Configuration with `setup()`
+
+Use the `setup()` method when your experiment requires custom functionality. Define custom instruments and task classes, import them into your code, and integrate them into your experiment within the `setup()` method of your experiment.

pyacquisition-0.1.0/docs/basics/getting_started.md

@@ -0,0 +1,14 @@
+# Getting Started
+
+On this page, we will run through a step-by-step example in which we will build an experiment from scratch. In this example we will introduce the concepts of `SoftwareInstruments`, `HardwareInstruments` and `Measurements` to interface with a Stanford Instruments Sr830 Lock-In Amplifier in order to record timestamped voltages. The process is generic to other instruments and measurements.
+
+# Adding software instruments
+
+A `SoftwareInstrument` is an instrument not associated with any physical hardware. We anticipate that the `Clock` will be
+included in most experiments to handle the production of timestamps, times and dates.
+
+# Adding hardward instruments
+
+## Configuring a communication backend
+
+# Adding measurements

pyacquisition-0.1.0/docs/basics/installation.md

@@ -0,0 +1,9 @@
+# Installation
+
+## Installation with `pip`
+
+## Installation with conda
+
+## Installing VISA
+
+## Dependency Management

pyacquisition-0.1.0/docs/experiment/experiment.md

@@ -0,0 +1 @@
+::: pyacquisition.core.experiment.Experiment

pyacquisition-0.1.0/docs/experiment/rack.md

@@ -0,0 +1 @@
+::: pyacquisition.core.rack.Rack

pyacquisition-0.1.0/docs/experiment/scribe.md

@@ -0,0 +1 @@
+::: pyacquisition.core.scribe.Scribe

pyacquisition-0.1.0/docs/experiment/task_manager.md

@@ -0,0 +1 @@
+::: pyacquisition.core.task_manager.TaskManager

pyacquisition-0.1.0/docs/index.md

@@ -0,0 +1,9 @@
+# PyAcquisition
+
+`pyacquisition` is a powerful Python package designed to simplify the process of recording scientific data and controlling laboratory instruments. It abstracts away the complexities of instrument communication, task scheduling (both concurrent and sequential), data recording, and logging, allowing you to focus on the science. Whether you're managing a single instrument or orchestrating a complex experimental workflow, `pyacquisition` provides a framework that simplifies the process dramatically.
+
+With `pyacquisition`, you can easily define your experimental setup in a configuration file (written in TOML format) and implement custom functionality by inheriting from the base `Experiment` class. Once configured, running your experiment is as simple as calling `my_experiment.run()`.
+
+## Mission
+
+`pyacquisition` was conceived to be an "all-python" solution to the recording of scientific data.

pyacquisition-0.1.0/docs/instruments/clock.md

@@ -0,0 +1,2 @@
+
+::: pyacquisition.instruments.software.Clock

pyacquisition-0.1.0/docs/tasks/overview.md

@@ -0,0 +1,11 @@
+# Tasks Overview
+
+`Tasks` can be queued for sequential execution. `pyacquisition` includes a number of core tasks that can be added to your experiment. Custom tasks can be created by inhereting from the `BaseTask` class and added to your experiment in the same way as core classes.
+
+
+## Creating a custom `Task`
+
+
+## Base Task
+
+::: pyacquisition.core.task.Task

pyacquisition-0.1.0/docs/tasks/wait_for.md

@@ -0,0 +1 @@
+::: pyacquisition.tasks.wait.WaitFor

pyacquisition-0.1.0/experiment.toml

@@ -0,0 +1,27 @@
+[experiment]
+root_path = "data"
+
+[rack]
+period = 0.25
+
+[instruments]
+clock = {instrument = "Clock"}
+lockin = {instrument = "SR_830", adapter="pyvisa", resource="GPIB0::8::INSTR"}
+
+[measurements]
+time = {instrument = "clock", method = "time"}
+vx = {instrument = "lockin", method = "get_x"}
+
+[data]
+path = "data_sub"
+
+[api_server]
+host = "localhost"
+port = 8005
+
+[logging]
+path = "logs"
+console_level = "DEBUG"
+gui_level = "DEBUG"
+file_level = "DEBUG"
+file_name = "debug.log"