ktaga-lab 0.1.4

Drivers for the experimental setup and tools for data acquisition and analysis.

ktaga-lab

Overview

ktaga-lab contains programs for experiments in Onolab. This repository is designed to facilitate various experimental setups and data analysis tasks.

Features

• Experiment setup scripts
• Data analysis tools
• Reproducible research environment

Prerequisites

To run this project, you need to install either of the following dependencies:

• pip
• Poetry (recommended)
• Docker (for analysis only)

Docker can be used for only data analysis tasks. For experiment setup, you need to install the dependencies using pip or Poetry.

Setup

Installation using Poetry

1. Install Poetry:

   • Linux/macOS:

     curl -sSL https://install.python-poetry.org | python3 -
     

   • Windows (PowerShell):

     (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
     

2. Setup environment

   Please make a pyproject.toml file in your directory for experiment or analysis. You can use a template file pyproject-env.toml provided in the repository. After creating the file, run the following command to install the dependencies:

   poetry install
   

3. Install ktaga-lab:

   poetry add ktaga-lab
   

4. Run the application:

   poetry run jupyter lab
   

Installation using pip

You can also install the package using pip. Run the following command to install the package:

pip install ktaga-lab

Installation using Docker

1. Clone the repository:

   git clone https://github.com/hoopdev/ktaga-lab.git
   cd ktaga-lab
   

2. Build the Docker image: Use the Dockerfile provided in the repository:

   docker build -t ktaga-lab .
   

3. Run the Docker container:

   docker run --rm -p 8888:8888 ktaga-lab
   

Access the application

Open your web browser and navigate to http://localhost:8888 to access the JupyterLab interface.

Usage

To use the tools and scripts provided in this repository, follow the instructions in the respective directories and files. Detailed documentation for each tool and script can be found within the repository.

License

This project is licensed under the MIT License. See the LICENSE file for more details.