Metadata-Version: 2.1
Name: LabelSIG
Version: 2.0.0
Summary: Signal Labeling with Python
Home-page: https://github.com/Jianhong-Gao/LabelSIG
Author: Jianhong Gao
Author-email: gaojianhong1994@foxmail.com
License: MIT
Keywords: Signal Labeling,Machine Learning
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown

<h1 align="center">
  <img src="https://github.com/Jianhong-Gao/LabelSIG/blob/main/labelsig/resource/WindowIcon.png?raw=true" width="30%"><br/>LabelSIG
</h1>


<h4 align="center">
  Electrical Signal Annotation with Python
</h4>

<div align="center">
  <a href="https://pypi.python.org/pypi/LabelSIG"><img src="https://img.shields.io/pypi/v/LabelSIG.svg"></a>
  <img src="https://img.shields.io/pypi/pyversions/LabelSIG.svg"></a>
</div>

<div align="center">
  <a href="https://github.com/Jianhong-Gao/LabelSIG/blob/main/#starter-guide"><b>Starter Guide</b></a>
  | <a href="https://github.com/Jianhong-Gao/LabelSIG/blob/main/#installation?raw=true"><b>Installation</b></a>
  | <a href="https://github.com/Jianhong-Gao/LabelSIG/blob/main/#usage"><b>Usage</b></a>
  | <a href="https://github.com/Jianhong-Gao/LabelSIG/blob/main/#examples"><b>Examples</b></a>
  <!-- | <a href="https://github.com/wkentaro/labelme/discussions"><b>Community</b></a> -->
  <!-- | <a href="https://www.youtube.com/playlist?list=PLI6LvFw0iflh3o33YYnVIfOpaO0hc5Dzw"><b>Youtube FAQ</b></a> -->
</div>

<br/>

# Description
LabelSIG is an electrical signal annotation tool inspired by [Labelme](https://github.com/labelmeai/labelme). Written in Python and utilizing Qt for its graphical interface, LabelSIG is designed for semantic segmentation tasks. Additionally, the tool can directly extract information from Common Format for Transient Data Exchange (COMTRADE) records. By using LabelSIG, various segments of samples are marked with different colors to easily identify their categories.
<div align="center">
  <img src="https://github.com/Jianhong-Gao/LabelSIG/blob/main/examples/semantic_segmentation/.readme/annotation.png?raw=true" width="80%">
</div>
For more information or to obtain the lastest LabelSIG, please contact us via email at gaojianhong1994@foxmail.com.

## Features

- [x] Signal annotation for comtrade file. 
- [x] Annotation for fault feeder or section for earth fault localization in distribution networks.

## Starter Guide

- **Installation guides** for only Windows platforms now 馃捇
- **Step-by-step tutorials**: first annotation to editing, exporting, and integrating with other programs 馃摃
- **A compilation of valuable resources** for further exploration 馃敆.

### Anaconda
You need install [Anaconda](https://www.continuum.io/downloads), then run below:

### Windows

Install [Anaconda](https://www.continuum.io/downloads), then in an Anaconda Prompt run:

```bash
conda create --name=LabeSIG python=3
conda activate LabeSIG
pip install LabeSIG
```
