Manage quantum yeild and photofatigue experiments
XChroma is a Python-based experiment control software designed to manage and automate optical experiments for measuring the quantum yield and photofatigue of photoswitchable proteins.
It supports programmable experimental sequences, allowing users to define custom light protocols for photoactivation and switching cycles.
- Experiment Control: Interfaces with hardware to measure absorbance properties.
- Programmable Sequences: Define and execute custom sequences to trigger photoswitchable proteins under various conditions.
- Real-Time Data Acquisition: Collect and process experimental data in real time.
- Modular Design: Easy to extend with additional experimental protocols and analysis routines.
Refer to the documentation quickstart for full setup instructions and usage examples.
-
Clone the repository:
git clone https://github.com/Alex6Crbt/XChroma.git cd XChroma -
Install the required packages:
pip install -r requirements.txt
-
Launch the app:
python main.py
Here’s a preview of the XChroma app interface:
The sequence.py file enables you to create and customize your own experimental sequences. For more details, refer to the documentation.
You can modify the SequenceWorker class to fit your needs or use the prebuilt measurement sequence classes available.
.
├── README.md
├── Spectrums.csv
├── XChroma
│ ├── __init__.py
│ ├── app.py
│ ├── arduino_control.py
│ ├── data_spectro.py
│ ├── process.py
│ ├── sequence_control.py
│ └── ui
│ ├── MainWindow.ui
│ ├── fonts/
│ ├── icons/
│ └── static/
├── docs
│ ├── Makefile
│ ├── make.bat
│ └── source
│ ├── _static/
│ ├── _templates/
│ ├── code/
│ ├── conf.py
│ ├── examples/
│ ├── index.rst
│ ├── quickstart.rst
│ └── userguide.rst
├── main.py
├── requirements.txt
└── sequence.py
Contributions are welcome! To contribute:
- Fork the repository.
- Create a feature branch (
git checkout -b my-feature). - Make your changes and test them.
- Open a pull request describing your changes.
For major changes, please open an issue first to discuss your ideas.
More in-depth user guides, API documentation, and tutorial videos will be added soon. Stay tuned for updates!