How do I install Dreamento on Ubuntu or Linux?

For real-time use, follow Option 3: use conda to create a virtual environment with specific packages like TensorFlow 1.13.1 and PyQt5, but note that functionality may differ and Windows is recommended. For offline, use conda with spyder and yasa, but expect potential minor issues.

Can Dreamento work with EEG devices other than ZMax, like Emotiv or BrainProducts?

Dreamento has some compatibility with BrainProducts for post-processing, but real-time features are optimized for ZMax. For other devices, you might need custom extensions due to the focus on ZMax integration and Hypnodyne software.

What is the accuracy of DreamentoScorer for automatic sleep staging?

DreamentoScorer is trained on over 130 datasets and provides hypnodensity outputs, but accuracy may vary for wide age ranges, sleep disorders, or short naps. The README advises manual validation in such cases, and N1 vs. REM confusion is noted with a post-scoring correction option.

How to synchronize EMG data with Dreamento EEG recordings?

Dreamento allows synchronization by integrating parallel EMG recordings during post-processing. You need to provide the EMG file along with EEG data, and the GUI will align them, as shown in the synchronization screenshot and described in the post-processing section.

Is Dreamento suitable for clinical sleep studies or only research?

It's primarily designed for dream engineering research with sensory stimulation and open-source extensions. For clinical use, the autoscoring may need validation, and the hardware dependency on ZMax could limit adoption in standard clinical setups with different devices.

How do I update Dreamento to get the latest features?

Use the AutomaticDreamentoUpdate.exe if you cloned the repository with git, as described in the 'Always stay up to date!' section. Otherwise, manually download updates from GitHub, but this requires git installation and proper directory setup.

Dreamento vs. other sleep analysis tools like Sleepy or Polysomnography software?

Dreamento stands out for real-time dream engineering with sensory stimulation and wearable EEG focus, while tools like Sleepy are more for offline analysis. However, Dreamento has a steeper learning curve and hardware lock-in compared to generic polysomnography software.

Dreamento — Python EEG Dream Engineering Toolbox

What is Dreamento?

Dreamento is an open-source Python toolbox for dream engineering that enables real-time monitoring, analysis, and sensory stimulation of sleep EEG data. It provides a graphical interface for recording and modulating sleep, along with offline tools for detailed post-processing, including automatic sleep scoring and event detection. The software is designed to work with wearable EEG devices like the ZMax headband.

Target Audience

Sleep researchers, neuroscientists, and dream engineering practitioners who need to conduct real-time EEG experiments or analyze sleep data with a focus on sensory stimulation and event detection.

Value Proposition

Dreamento offers a unique, integrated open-source platform for both real-time dream engineering and offline sleep analysis, featuring validated algorithms like YASA for event detection and a modular design that encourages community extensions.

Dreamento (DReam ENgenieering TOolbox): a Python-based software for dream engineering while monitoring/analyzing real-time EEG data.

Use Cases

Best For

Real-time EEG monitoring and sensory stimulation during sleep studies
Automatic sleep stage scoring (autoscoring) of wearable EEG data
Detecting sleep microstructures like spindles and slow oscillations
Synchronizing EEG data with other physiological recordings (e.g., EMG)
Batch processing and analysis of multiple sleep recordings
Manual and consensus sleep scoring for research validation

Not Ideal For

Projects using non-wearable EEG systems or devices other than Hypnodyne ZMax
Teams needing a plug-and-play solution without Python dependency management or virtual environments
Real-time applications on non-Windows operating systems due to limited optimization and support
Research focused purely on clinical sleep staging without interest in sensory stimulation or dream engineering

Pros & Cons

Pros

Integrated Real-time Monitoring

Provides live EEG visualization with adjustable time and amplitude scales, plus real-time spectrogram analysis, enabling immediate feedback during sleep experiments as highlighted in the real-time features section.

Validated Event Detection

Uses YASA algorithms for automatic detection of sleep microstructures like spindles, slow oscillations, and REM eye movements, offering reliable offline analysis with ERP representations shown in the README screenshots.

Modular Open-Source Design

Built as a modular platform that encourages researchers to extend features, promoting transparency and collaboration, as stated in the philosophy and overview sections.

Sensory Stimulation Capabilities

Supports delivery of visual, auditory, and tactile stimuli during sleep, making it unique for dream engineering research, as detailed in the real-time features list.

Bulk Processing Efficiency

Enables batch conversion, scoring, and analysis of multiple recordings through tools like DreamentoConverter and bulk autoscoring, saving time for large datasets as described in the post-processing features.

Cons

Complex Installation Process

Requires separate virtual environments for real-time and offline use with specific conda or pip commands, and Windows is highly recommended, making setup cumbersome for non-experts or cross-platform users.

Real-time Autoscoring Limitations

Admits that real-time sleep staging is 'not ideal yet, still under development,' which may affect reliability for immediate feedback applications, as noted in the autoscoring section.

Hardware and Software Dependency

Primarily designed for Hypnodyne ZMax headband and requires Hypnodyne software like HDServer and HDRecorder, limiting flexibility for other EEG devices or workflows.

OS-Specific Performance Issues

Functionality may differ on Linux-based systems with minor dependency issues, and real-time use is best on Windows, as warned in the installation notes, reducing portability.

Frequently Asked Questions

What is Dreamento?

Target Audience

Sleep researchers, neuroscientists, and dream engineering practitioners who need to conduct real-time EEG experiments or analyze sleep data with a focus on sensory stimulation and event detection.

Value Proposition

Use Cases

Best For

Real-time EEG monitoring and sensory stimulation during sleep studies
Automatic sleep stage scoring (autoscoring) of wearable EEG data
Detecting sleep microstructures like spindles and slow oscillations
Synchronizing EEG data with other physiological recordings (e.g., EMG)
Batch processing and analysis of multiple sleep recordings
Manual and consensus sleep scoring for research validation

Not Ideal For

Projects using non-wearable EEG systems or devices other than Hypnodyne ZMax
Teams needing a plug-and-play solution without Python dependency management or virtual environments
Real-time applications on non-Windows operating systems due to limited optimization and support
Research focused purely on clinical sleep staging without interest in sensory stimulation or dream engineering

Pros & Cons

Pros

Integrated Real-time Monitoring

Validated Event Detection

Modular Open-Source Design

Built as a modular platform that encourages researchers to extend features, promoting transparency and collaboration, as stated in the philosophy and overview sections.

Sensory Stimulation Capabilities

Supports delivery of visual, auditory, and tactile stimuli during sleep, making it unique for dream engineering research, as detailed in the real-time features list.

Bulk Processing Efficiency

Cons

Complex Installation Process

Real-time Autoscoring Limitations

Admits that real-time sleep staging is 'not ideal yet, still under development,' which may affect reliability for immediate feedback applications, as noted in the autoscoring section.

Hardware and Software Dependency

Primarily designed for Hypnodyne ZMax headband and requires Hypnodyne software like HDServer and HDRecorder, limiting flexibility for other EEG devices or workflows.

OS-Specific Performance Issues

Functionality may differ on Linux-based systems with minor dependency issues, and real-time use is best on Windows, as warned in the installation notes, reducing portability.

Frequently Asked Questions

Dreamento

What is Dreamento?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Dreamento

What is Dreamento?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?