Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TKosir committed Nov 16, 2023
1 parent 11e98be commit 6bcceaa
Showing 1 changed file with 28 additions and 10 deletions.
38 changes: 28 additions & 10 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,44 @@
contain the root `toctree` directive.
Welcome to LDAQ documentation!
===============================================================
==============================

This package provides an extendable interface for data acquisition and generation. It is designed to be quickly set-up, easy to use and accomodate a wide range of data sources.
What is LDAQ?
-------------

The source-code for this package is available on `GitHub <https://github.com/ladisk/LDAQ>`_.
LDAQ stands for **L**\ ightweight **D**\ ata **A**\ c\ **Q**\ uisition, a Python-based toolkit designed to make data collection seamless and efficient. Whether you're a researcher, engineer, or hobbyist, LDAQ offers a powerful yet user-friendly platform to gather
data from a wide range of hardware sources. The package enables data **acquisition** and signal **generation** from multiple hardware sources, and costumizable **live data visualization**.

Key Features:
-------------

- 🐍 **Python-Powered**: Built on the robust and versatile Python language, LDAQ harnesses its power to offer a streamlined data collection process. It's compatible with all Python environments, ensuring ease of integration into your existing workflows.

- 📟 **Diverse Hardware Compatibility**: LDAQ supports a variety of hardware sources, including:

- National Instruments

- Digilent

- Serial communication devices (i.e. Arduino, ESP)

- FLIR Cameras

The package enables data **acquisition** and signal **generation** from multiple hardware sources, and costumizable **live data visualization**.
- Simulated hardware

- 📊 **Advanced Data Visualization & Analysis**: LDAQ doesn’t just collect data; it helps you understand it. With built-in features like real-time signal visualization and Fast Fourier Transform (FFT) analysis, you can dive deep into your data for more insightful discoveries.

- ⚙️ **Customization & Flexibility**: Tailor LDAQ to your specific needs. Whether you're dealing with high-speed data streams or complex signal processing, LDAQ's customizable framework allows you to optimize and accelerate your data acquisition processes.


The source-code for this package is available on `GitHub <https://github.com/ladisk/LDAQ>`_.

See :doc:`simple_start` for a quick start guide.

See :doc:`tutorials` to learn about different LDAQ features.

For more advanced use cases of currently supported hardware see notebook :doc:`examples`.

.. note::

To quickly add acquisition code to your project, go to the :doc:`snippets` page, where you can copy and paste the code you need.

Table of Contents
=================
.. toctree::
Expand All @@ -35,8 +55,6 @@ Table of Contents
code
examples



Indices and tables
==================

Expand Down

0 comments on commit 6bcceaa

Please sign in to comment.