README.md

Khiops Visualization NPM Component

Intuitive visualization of Khiops analysis results

🌐 Khiops Visualization Live Demo

---

📖 Table of Contents

• About
• Quick Start
• Installation
• Usage
• Development
• Testing
• License

🔍 About

This repository contains the source code for Khiops Visualization and Khiops Covisualization tools, unified into a single, powerful npm package. Built with Angular and modern web technologies, it provides comprehensive data visualization capabilities for machine learning analysis.

---

Integration Notice:

• The khiops-visualization part of this npm library was previously integrated into the kv-electron project.
• The khiops-covisualization part was previously integrated into the kc-electron project.
• They have since been unified into a single desktop application:
  👉 https://github.com/KhiopsML/khiops-visualization-desktop

🚀 Quick Start

# Install the package
npm install khiops-visualization
# or
yarn add khiops-visualization

// Import in your Angular module
import { KhiopsVisualizationModule } from 'khiops-visualization';

@NgModule({
  imports: [KhiopsVisualizationModule],
  // ...
})
export class YourModule {}

📦 Installation

Prerequisites

• Node.js - Download Node.js
• npm or Yarn - We recommend Yarn

Install Dependencies

yarn install

📚 Usage

Basic Implementation

import { Component } from '@angular/core';

@Component({
  selector: 'app-example',
  template: ` <khiops-visualization [data]="visualizationData"></khiops-visualization> `,
})
export class ExampleComponent {
  visualizationData = {
    // Your Khiops analysis data
  };
}

Sample Data

Test files and examples can be found in the ./src/assets/mocks folder.

🛠 Development

Technology Stack

• Framework: Angular
• UI Library: Angular Material
• Testing: Karma + Cypress
• Build System: Angular CLI

Development Server

Start the development server:

yarn start

Navigate to http://localhost:4200/. The application will automatically reload when you make changes to the source files.

Project Structure

src/
├── app/
│   ├── khiops-visualization/     # Main visualization module
│   ├── khiops-covisualization/   # Covisualization module
│   └── khiops-library/           # Shared library components
├── assets/
│   └── mocks/                    # Sample data files
└── environments/                 # Environment configurations

Development Demos Versions

The current development versions are accessible here:

• DEV VERSION Visualization

🧪 Testing

Unit Tests

Run unit tests with Karma:

yarn test

Run unit tests with watch:

yarn test:watch

Run single test

yarn test:watch --include="**/preparation-2d-datas.service.spec.ts"

End-to-End Tests

Run e2e tests with Cypress:

yarn e2e

Bundle Compilation

powershell -ExecutionPolicy Bypass -File ".\scripts\build.ps1"

or

yarn build:webcomponents

📄 License

This software is distributed under the BSD 3-Clause-clear License, the text of which is available at https://spdx.org/licenses/BSD-3-Clause-Clear.html or see the LICENSE for more details.