icarus_v2 0.3.0

Monitoring software for the Icarus Pressure Jump apparatus

icarus v2

Monitoring software for the Icarus NMR pressure jump apparatus

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The Icarus NMR Pressure Jump Apparatus is a novel device used to rapidly switch the pressure within an NMR sample cell. This enables study of the unfolded protein under native conditions and, vice versa, study of the native protein under denaturing conditions. This project is the second version of a monitoring software for the pressure sensors and digital controls. It is responsible for displaying device readings, controlling and testing hardware, and detecting faults.

Once a DATAQ DI-4108 USB device (check out its protocol here) is detected by the monitoring software, it establishes a connection and begins reading data from the USB device at 4000Hz. The analog and digital channels monitored are as follows:

• Analog:
  CH0: target pressure sensor
  CH1: depressurization valve lower sensor
  CH2: depressurization valve upper sensor
  CH3: pressurization valve lower sensor
  CH4: pressurization valve upper sensor
  CH5: high pressure sensor at the origin
  CH6: high pressure sensor at the sample
• Digital:
  CH0: high pressure pump control
  CH1: depressurize valve control
  CH2: pressurize valve control
  CH4: log control

The data is stored in a circular buffer with a default length of 2 minutes. The data is read by many event handlers which each detect certain features in the readings. They then signal events containing their respective data which may be read by the GUI. The event handlers are as follows:

1. Depressurize: detects high to low state transitions in digital CH0
2. Pressurize: detects high to low state transitions in digital CH1
3. Period: detects consecutive high to low state transitions in digital CH1
4. Pressure: detects current pressure of analog CH5
5. Pump: detects drops in analog CH0, signifying the pump stroking
6. Log: detects state changes in digital CH4

The digital channels may be controlled by the software by sending commands to the DATAQ DI-4108. This is used for the following:

1. Toggling the high pressure pump
2. Hardware tests under manual device operation
3. Shutdowns, either manual or when a fatal error is detected by the Sentry

All events are transmitted to the GUI and are rendered in dedicated event plots, history plots, and status indicators. They are also transmitted to a Sentry module which analyzes them to detect leaks and abnormal behavior. In the event of a serious leak, the device will automatically shut down. Pressurize, depressurize, and period events are also transmitted to a logger, which generates LZMA compressed log files. These files may be opened by the GUI for later viewing.

(back to top)

Built With

• Python >=3.10, <=3.12

• PySide6

• PyQtDarkTheme

Development tools

• Poetry

(back to top)

Getting Started

Prerequisites

System Requirements

• Ubuntu 22.04 LTS or later (primary supported OS)
• Other Linux distributions with Python 3.10-3.12 support may work but are not officially supported
• macOS 11 (Big Sur) or later may work but is not officially supported
• Windows 10 or later may work but is not officially supported

Installing Python

Ensure you have Python 3.10-3.12 installed on your system by running the following command.

python3 --version

If Python is not installed, or you need a different version, follow the installation instructions for your operating system from the official Python documentation: https://www.python.org/downloads/.

Installation

The recommended method for installation is to install the application globally using pipx. If pipx is not installed on your system, follow the official installation instructions here: https://pypa.github.io/pipx/installation/

Now, you can install the icarus_v2 package:

pipx install icarus_v2

Updating

To update the application to the latest version, use:

pipx upgrade icarus_v2

(back to top)

Usage

To start the application, run the following command from any directory:

icarus

• Note: The first time the application is run with a DATAQ connected, it will attempt to install a udev rule to allow access to the USB device. This requires admin permissions. If the application fails to connect to the device after a few seconds, reboot your computer to ensure the udev rules are fully reloaded.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Environment Setup

Installing Poetry

This project uses poetry to manage dependencies. To install it, follow the instructions found in the documentation at https://python-poetry.org/docs.

Cloning the Repository

Before you can start setting up your environment, you'll need to clone the repository containing the project. Open your terminal and execute the following command:

git clone https://github.com/SeanIFitch/icarus_v2
cd icarus_v2

Installing Dependencies

Now you can initialize the poetry package:

poetry install

Run Icarus

To run the main script, you can use the following command from the directory into which you cloned the repository:

poetry run icarus

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Sean Fitch - [e-mail]

Project Link: https://github.com/SeanIFitch/icarus_v2

(back to top)

Acknowledgments

• Dr. Philip Anfinrud - Software specification
• icarus-nmr by Valentyn Stadnytskyi

(back to top)