{"id":19923587,"url":"https://github.com/sukarnascience/thd_analysis_tool","last_synced_at":"2025-10-23T18:04:39.578Z","repository":{"id":247043542,"uuid":"824869582","full_name":"Sukarnascience/THD_Analysis_Tool","owner":"Sukarnascience","description":"A Software for EEE Department which dose Total Harmonic Distortion Analysis ","archived":false,"fork":false,"pushed_at":"2024-07-16T02:35:10.000Z","size":3863,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-01T10:21:25.338Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sukarnascience.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-06T07:09:31.000Z","updated_at":"2024-07-16T02:35:00.000Z","dependencies_parsed_at":"2024-07-16T05:55:20.027Z","dependency_job_id":null,"html_url":"https://github.com/Sukarnascience/THD_Analysis_Tool","commit_stats":null,"previous_names":["sukarnascience/thd_analysis_tool"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Sukarnascience/THD_Analysis_Tool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sukarnascience%2FTHD_Analysis_Tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sukarnascience%2FTHD_Analysis_Tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sukarnascience%2FTHD_Analysis_Tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sukarnascience%2FTHD_Analysis_Tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sukarnascience","download_url":"https://codeload.github.com/Sukarnascience/THD_Analysis_Tool/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sukarnascience%2FTHD_Analysis_Tool/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267706887,"owners_count":24131259,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T22:14:48.879Z","updated_at":"2025-10-23T18:04:34.547Z","avatar_url":"https://github.com/Sukarnascience.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# THD Analysis Tool\n\n## Project Structure\n\n```\nC:.\n├───docs\n|   └── ...\n├───src\n│   ├───assets\n│   │   └───manifest.json\n|   |   └── ...\n│   ├───__pycache__\n|   ├── main.py\n|   └── ...\n└───test\n    └───dummyTHD\n```\n\n## Description\n\nThis project is a digital serial plotter designed to read and display sensor data in real-time. The configuration details, including device connections and value units, are defined in the `manifest.json` file located in the `assets` folder.\n\n## Getting Started\n\n### Prerequisites\n\nEnsure you have Python installed on your system. The recommended Python version is defined in the `manifest.json` file. If your Python version does not match, use the `quick_setup.bat` file to download the required libraries.\n\n### Installation\n\n1. **Install Dependencies:**\n   Run the `install.bat` file to install all required dependencies.\n   ```bash\n   install.bat\n   ```\n\n2. **Quick Setup:**\n   If you encounter issues with the installation, use the `quick_setup.bat` file to download and install the necessary libraries.\n   ```bash\n   quick_setup.bat\n   ```\n\n### Running the Application\n\n1. **Start the Application:**\n   Use the `start.bat` file to launch the application.\n   ```bash\n   start.bat\n   ```\n\n### Configuration\n\nBefore starting the application, you need to configure the `manifest.json` file located in the `assets` folder.\n\n```json\n{\n  \"name\": \"THD Analysis Tool\",\n  \"version\": \"5.4.0\",\n  \"license\": \"GNU\",\n  \"theme\": \"dark\",\n  \"color\": \"green\",\n  \"outsource\": {\n    \"NWT 4\": \"C:/path/to/nwt4\",\n    \"NWT 5\": \"C:/path/to/nwt5\",\n    \"Deploy Graph\": \"C:/path/to/display_graph.py\"\n  },\n  \"units\": [\n    \"VOLTAGE\",\n    \"CURRENT\",\n    \"PF\",\n    \"kW\",\n    \"kVA\",\n    \"kVAR\",\n    \"FREQUENCY\",\n    \"kWh\",\n    \"kVAh\"\n  ]\n}\n```\n\n### Edit Configuration\n\n1. **Outsource Paths:**\n   Update the paths in the `outsource` key based on your system's directory structure.\n\n2. **Units:**\n   Ensure the units listed in the `units` key match the units your device will output.\n\n## Testing Without a Device\n\nIf you do not have access to the actual device, you can test the software using the dummy Arduino code provided.\n\n1. **Dummy Device Setup:**\n   Upload the Arduino code located in `test/dummyTHD` to any Arduino board to simulate the device.\n\n## Source Files\n\n### `config.py`\nHandles the configuration settings and reads the `manifest.json` file to apply the configurations.\n\n### `device_handler.py`\nManages the connection and communication with the device, including reading sensor data.\n\n### `display_graph.py`\nHandles the plotting and graphical display of the sensor data in real-time.\n\n### `main.py`\nThe main script that initializes the application and manages the overall workflow.\n\n## Screenshots\n\nHere are some screenshots to demonstrate how the software works:\n\n### Main UI\n![Main UI](Docs/main_ui.png)\n![Main UI Running](Docs/main_ui2.png)\n\n### Live Backup\n![Live Backup](Docs/live_backup.png)\n\n### Digital Values Plotting\n![Digital Values null](Docs/digital_values1.png)\n![Digital Values running](Docs/digital_values2.png)\n\n### Graphical Data Plotting\n![Graphical Data](Docs/graphical_data.png)\n\n## Contact\n\nFor any issues or further assistance, please contact Sukarna Jana at sukarnascience@gmail.com.\n\n## License\n\nThis project is licensed under the GNU General Public License v3.0.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsukarnascience%2Fthd_analysis_tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsukarnascience%2Fthd_analysis_tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsukarnascience%2Fthd_analysis_tool/lists"}