FOSSEE · HARIOM-BEEP · Jun 8, 2025 · Jun 8, 2025 · Jun 8, 2025 · Jun 8, 2025
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,40 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+    #jobs:
+    #  pre_build:
+    #    - pip install -r requirements.txt
+python:
+  install:
+    - requirements: code/requirements.txt
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#     - requirements: docs/requirements.txt
diff --git a/.travis.yml b/.travis.yml
@@ -3,11 +3,15 @@ language: python
 cache: pip
 
 git:
-    depth: 5
-    quiet: true
+  depth: 5
+  quiet: true
 
 python:
-    - "3.6"
+  - "3.6"
+
+install:
+  - pip install flake8
+
+script: true
+#  - find . -name \*.py -print0 | sort -z | xargs -r0 flake8
 
-script:
-    - find . -name \*.py -print0 | sort -z | xargs -r0 flake8
diff --git a/INSTALL b/INSTALL
@@ -14,7 +14,7 @@ Table of contents
 
    	i.      After downloading eSim, extract it using: 
 
-   		       $ unzip eSim-2.4.zip
+   		       $ unzip eSim-2.5.zip
 
    	ii.     Now change directories in to the top-level eSim directory (where this INSTALL file can be found).
 
@@ -39,24 +39,18 @@ Table of contents
 
 
 
-2.  eSim 2.4 installation in Windows OS
+2.  eSim installation in Windows OS
 
-    i.      Download eSim for Windows OS from "https://esim.fossee.in/". Disable the antivirus (if any).
+     i.     Download eSim for Windows OS from "https://esim.fossee.in/". Disable the antivirus (if any).
 
-    ii.     If MinGW and/or MSYS is already installed in your machine, then remove it from the
+     ii.    If MinGW and/or MSYS is already installed in your machine, then remove it from the
             PATH environment variable as it may interfere with eSim and might not work as intended.
 
     iii.    Now double click on eSim installer and then follow the instruction to install eSim.
 
-    iv.     After the installation is completed, please download and add the following file to the esim home directory(FOSSEE\eSim\ folder):
-            https://github.com/FOSSEE/eSim/blob/master/src/frontEnd/TerminalUi.ui#L6
+     iv.    Hence the installation is completed.
 
-    v.      Please download and add the following executable to the nghdl folder(FOSSEE\eSim\nghdl\src location):
-            https://drive.google.com/file/d/17MNCCq9cG6A7fnIH-4KMUMY-yb4rW9s4/view?usp=sharing
-
-    vi.     Hence the installation is completed.
-
-    vii.    To uninstall eSim and all of its components, run the uninstaller "uninst-eSim.exe" located at 
+      v.    To uninstall eSim and all of its components, run the uninstaller "uninst-eSim.exe" located at 
             top-level eSim directory (where this INSTALL file can be found).
 
 

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 ![GitHub](https://img.shields.io/github/license/fossee/esim?color=blue)
 ![Python](https://img.shields.io/badge/python-v3.6+-blue.svg)
 [![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
-![Travis (.org)](https://img.shields.io/travis/fossee/esim)
+![Travis (.com)](https://img.shields.io/travis/com/Eyantra698Sumanto/eSim)
 [![Documentation Status](https://readthedocs.org/projects/esim/badge/?version=latest)](https://esim.readthedocs.io/en/latest/?badge=latest)
 [![GitHub forks](https://img.shields.io/github/forks/fossee/esim)](https://github.com/fossee/esim/network)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://github.com/fossee/esim)
@@ -15,7 +15,7 @@ It is an integrated tool build using open source softwares such as KiCad, Ngspic
 
 ## Releases and Installation
 eSim is released for the following distributions (operating systems):
-* Ubuntu 18.04, 20.04 LTS versions.
+* Ubuntu 22.04, 23.04, 24.04 LTS versions.
 * Microsoft Windows 8, 10 and 11.
 
 To use eSim on your machine having above distributions, please refer to link [here](https://esim.fossee.in/downloads) for installation and other guidelines.
@@ -39,11 +39,13 @@ To use eSim on your machine having above distributions, please refer to link [he
 * [SkyWater SKY130 PDK](https://skywater-pdk.rtfd.io/)
 
 ## eSim Manual
-To know everything about eSim, how it works and it's feature please download the manual from [here](https://static.fossee.in/esim/manuals/eSim_Manual_2.4.pdf)
+To know everything about eSim, how it works and it's feature please download the manual from [here](https://static.fossee.in/esim/manuals/eSim_Manual_2.5.pdf)
 
 ## Contact
 For any queries regarding eSim please write us on at this [email address](mailto:contact-esim@fossee.in).
 
+Other Contact Details are available [here](https://esim.fossee.in/contact-us).
+
 ## Contribution
 Please refer [here](https://github.com/FOSSEE/eSim/blob/master/CONTRIBUTION.md) for further details.
 

diff --git a/README_CHATBOT.md b/README_CHATBOT.md
@@ -0,0 +1,124 @@
+# eSim Copilot – AI-Assisted Electronics Simulation Tool
+
+eSim Copilot is an AI-powered assistant integrated into **eSim**, designed to help users analyze electronic circuits, debug SPICE netlists, understand simulation errors, and interact using text, voice, and images.
+
+This project combines **PyQt5**, **ngspice**, **Ollama (LLMs)**, **RAG (ChromaDB)**, **OCR**, and **offline speech-to-text** into a single desktop application.
+
+---
+
+## Key Features
+
+-  AI assistant for electronics & eSim
+-  Netlist analysis and error explanation
+-  ngspice simulation integration
+-  Circuit image analysis (OCR + vision models)
+-  Offline speech-to-text (no internet required)
+-  Knowledge base using RAG (manuals + docs)
+-  Fully offline-capable (except model downloads)
+
+## Supported Platform
+
+- **Linux only** (Recommended: Ubuntu 22.04 / 23.04 / 24.04)
+- Tested on **Ubuntu 22.04 & 24.04**
+
+---
+
+## Python Version (VERY IMPORTANT)
+
+## Supported
+- **Python 3.9 – 3.10 (RECOMMENDED)**
+
+Check version:
+```bash
+python --version
+
+## System Dependencies (Install First)
+```bash
+
+sudo apt update
+sudo apt upgrade
+
+sudo apt update
+sudo apt install -y \
+  libxcb-xinerama0 \
+  libxcb-cursor0 \
+  libxkbcommon-x11-0 \
+  libxcb-icccm4 \
+  libxcb-image0 \
+  libxcb-keysyms1 \
+  libxcb-render-util0 \
+  libxcb-xinput0 \
+  libxcb-shape0 \
+  libxcb-randr0 \
+  libxcb-util1 \
+  libgl1 \
+  libglib2.0-0
+
+## Clone the Repository
+
+git clone <https://github.com/HARIOM-BEEP/eSim>
+cd eSim-master
+
+## Ollama (LLM Backend)
+```bash
+
+curl -fsSL https://ollama.com/install.sh | sh
+ollama serve
+ollama pull qwen2.5:3b
+ollama pull minicpm-v
+ollama pull nomic-embed-text
+
+## Offline Speech-to-Text (VOSK)
+```bash
+
+mkdir -p ~/vosk-models
+cd ~/vosk-models
+wget https://alphacephei.com/vosk/models/vosk-model-small-en-us-0.15.zip
+unzip vosk-model-small-en-us-0.15.zip
+
+export VOSK_MODEL_PATH=~/vosk-models/vosk-model-small-en-us-0.15
+
+echo 'export VOSK_MODEL_PATH=~/vosk-models/vosk-model-small-en-us-0.15' >> ~/.bashrc
+source ~/.bashrc
+
+## Python Virtual Environment (Recommended)
+```bash
+
+python3.10 -m venv venv
+source venv/bin/activate
+pip uninstall -y pip
+python -m ensurepip
+python -m pip install pip==22.3.1
+python -m pip install setuptools==65.5.0 wheel==0.38.4
+
+python -m pip install hdlparse==1.0.4 --no-build-isolation
+
+pip install -r requirements.txt
+
+pip install paddlepaddle==2.5.2 \
+  -f https://www.paddlepaddle.org.cn/whl/linux/mkl/avx/stable.html
+
+pip uninstall -y opencv-python opencv-contrib-python opencv-python-headless
+pip install opencv-python-headless==4.6.0.66
+
+## Before running eSim
+
+unset QT_PLUGIN_PATH
+export QT_QPA_PLATFORM=xcb
+
+## Ingest manuals for RAG 
+```bash
+cd src
+python ingest.py
+
+## Running the Application
+```bash
+cd src/frontEnd
+python Application.py
+
+## Common Warnings (Safe to Ignore)
+
+PaddleOCR init failed: show_log
+QSocketNotifier: Can only be used with threads started with QThread
+libpng iCCP: incorrect sRGB profile
+PyQt sipPyTypeDict() deprecation warnings
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.4
+2.5
diff --git a/code/_static/TerminalUI.png b/code/_static/TerminalUI.png
diff --git a/code/_static/anylasis.png b/code/_static/anylasis.png
diff --git a/code/_static/custom.css b/code/_static/custom.css
@@ -0,0 +1,3 @@
+.wy-side-nav-search{
+    padding-top: 50px;
+}
diff --git a/code/_static/helpButton.png b/code/_static/helpButton.png
diff --git a/code/_static/history.png b/code/_static/history.png
diff --git a/code/_static/logo.png b/code/_static/logo.png
diff --git a/code/_static/projectExplorer.png b/code/_static/projectExplorer.png
diff --git a/code/_static/pythonPlot.png b/code/_static/pythonPlot.png
diff --git a/code/_static/welcome.png b/code/_static/welcome.png
diff --git a/code/_static/workspace.png b/code/_static/workspace.png
diff --git a/code/_templates/layout.html b/code/_templates/layout.html
@@ -0,0 +1,13 @@
+{% extends "!layout.html" %}
+
+{% block sidebartitle %}
+  <div style="width: 50%; padding: 0; margin: 0; margin-left: 69px;">
+    <img src="{{ pathto('_static/logo.png', 1) }}"
+         alt="My Logo"
+         style="width: 100%; height: auto; display: block;" />
+    <div class="verison" style="color: #111; font-weight: bold; margin-bottom: 20px;">
+        eSim 2.5
+    </div>
+  </div>
+  {{ super() }}
+{% endblock %}
diff --git a/code/browser/UserManual.rst b/code/browser/UserManual.rst
@@ -1,6 +1,14 @@
 User Manual Component
 =====================
+.. note::
+
+   Source : ``/src/browser/UserManual.py``
 
 .. automodule:: browser.UserManual
 	:members:
 
+.. image:: ../_static/helpButton.png
+    :alt: Screenshot of the Welcome page
+    :align: left
+    :scale: 100%
+
diff --git a/code/browser/Welcome.rst b/code/browser/Welcome.rst
@@ -1,5 +1,14 @@
 Welcome Component
 =================
 
+.. note::
+
+   Source : ``/src/browser/Welcome.py``
+
 .. automodule:: browser.Welcome
 	:members:
+
+.. image:: ../_static/welcome.png
+    :alt: Screenshot of the Welcome page
+    :align: center
+    :scale: 50%
diff --git a/code/configuration/Appconfig.rst b/code/configuration/Appconfig.rst
@@ -1,5 +1,17 @@
 Configuration Component
 =======================
 
+This is the configuration file :
+
+1. Stores default values, such as workspace path, project/subcircuit info, and configuration paths.
+2. Loads configuration files (like config.ini).
+3. Reads from workspace.txt to determine the current workspace.
+4. Provides helper functions to log messages (info, warning, error).
+5. Tracks spawned processes and UI elements like dock widgets.
+
+.. note::
+
+   Source : ``/src/configuration/Appconfig.py``
+
 .. automodule:: configuration.Appconfig
 	:members:
diff --git a/code/converter.rst b/code/converter.rst
@@ -0,0 +1,12 @@
+Converter Component
+========================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    converter/browserSchematic
+    converter/libConverter
+    converter/LtspiceLibConverter
+    converter/ltspiceToKicad
+    converter/pspiceToKicad
diff --git a/code/converter/LtspiceLibConverter.rst b/code/converter/LtspiceLibConverter.rst
@@ -0,0 +1,18 @@
+LTspice Library Converter
+=========================
+
+This module enables conversion of LTspice library files for use within eSim.
+
+**Features:**
+- Parses and converts `.lib` and `.sub` files from LTspice.
+- Handles symbol and model translation for compatibility.
+
+**Usage:**
+Use the provided interface or scripts to import LTspice libraries into your eSim projects.
+
+.. note::
+
+   Source : ``src/converter/LtspiceLibConverter.py``
+
+.. automodule:: converter.LtspiceLibConverter
+   :members:
diff --git a/code/converter/browserSchematic.rst b/code/converter/browserSchematic.rst
@@ -0,0 +1,18 @@
+Browse Schematics
+=================
+
+This module provides a graphical interface for selecting and loading schematic files in eSim.
+
+.. note::
+   Source : ``src/converter/browseSchematics.py``
+
+.. automodule:: converter.browseSchematics
+   :members:
+
+**Features:**
+- Allows users to browse and select supported schematic files (`.sch`, `.asc`, `.slb`, `.asy`).
+- Integrates with the eSim converter tools for further processing.
+
+**Usage:**
+Use the file browser dialog to select your schematic file. Supported file types are filtered for convenience.
+