pica-suite 1.0.0__tar.gz

pica_suite-1.0.0/CHANGELOG.md

@@ -0,0 +1,191 @@
+go through [releases](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/releases) and [tags](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/tags), for the finalised released versions
+## Instrument & Software Update Log
+---
+### [1.0.0] - 2025-12-15 (Initial Public Release) (Current)
+
+- **Versioning**: Version numbering has been reset from legacy development builds (v17.0) to v1.0.0 to standardize the package for public distribution and citation. This version will be updated soon, possibly this week.
+- **JOSS Submission**: Cleaned up documentation, performed fresh install tests, and completed other proofreading in preparation for submission to the Journal of Open Source Software (JOSS).
+
+---
+
+### [17.0] - 2025-12-02 
+
+**Changed**
+
+- **Directory Structure**: Refactored codebase into a professional project structure; moved numerous files to appropriate subdirectories for better organization.
+- **Versioning**: Standardized version naming conventions. Adopted Semantic Versioning (v17.0).
+
+**Research & Documentation**
+
+- **Paper Draft**: Completed and presented the first draft of the research paper to Dr. Sudip Mukherjee.
+- **Feedback**: Received critical feedback regarding the inclusion of ATMS (Advanced Transport Measurement Systems).
+
+### [Community] - 2025-12-01
+
+- **Launch**: PICA project posted on Hacker News.
+---
+### Version 15.0 
+*Released: November 22, 2025*
+*Status: Tested and operational. Minor cosmetic updates pending.*
+
+**JOSS Submission & Professionalization**
+
+-   **Code Cleanup**: Comprehensive refactoring and cleanup of the codebase to meet professional standards for JOSS submission.
+
+**A Note on Recent Updates and Testing**:
+
+> This software suite is actively used for daily laboratory measurements and is regularly tested on the physical instruments. Recently, a suite of automated tests has been integrated to improve code quality and stability. While these tests validate the core logic, the changes made to support them require a new round of thorough manual testing on the hardware to identify and resolve any practical bugs that may have been introduced. This process is currently underway, and further updates will be provided upon its completion.
+
+---
+
+### Version 14.0 and 14.1
+*Released: November 15, 2025*
+-   **Improved "Getting Started" Guide:** Clarified installation and launch instructions.
+-   **Enhanced Documentation:** Overhauled the main project `README.md` to provide a more comprehensive overview, including a new "Architecture" section that details the frontend-backend separation and the role of `multiprocessing`.
+-   **Synchronized Executable README:** Updated `PICA_README.md` for the standalone executable.
+
+**GUI Enhancements & New Measurement Modes**
+-   **Major GUI Version Bumps:** Updated numerous frontend scripts to their latest stable versions.
+-   **New Passive "Sensing" Modes:** Introduced "T-Sensing" modes for resistance logging during external temperature changes.
+    -   New `Delta Mode R-T (T_Sensing)` module.
+    -   New `K2400 R-T (T_Sensing)` module.
+    -   New `K2400_2182 R-T (T_Sensing)` module.
+    -   New `K6517B R-T (T_Sensing)` module.
+-   **Plotter Utility Upgrade:** Enhanced `PlotterUtil_GUI.py` to support simultaneous multi-file plotting.
+
+---
+
+### Version 13.10 (Lab Baseline)
+*Released: October 10, 2025*
+
+**Milestone: Base Laboratory Deployment**
+-   **Status:** A stable base version for the laboratory is in place. Almost all core instrument communication and measurement loops are working perfectly.
+-   **Context:** This release (`b545cef`) marked the completion of functional development before the focus shifted to cosmetic UI improvements and standardization.
+
+---
+
+### Version 13.9
+*Released: October 09, 2025*
+
+**Documentation & Launcher Synchronization**
+-   **Documentation Overhaul:** Synchronized `README.md` and `Change_Logs.md`.
+-   **Executable-Specific README:** Created `PICA_README.md`.
+-   **Launcher Script Update:** Updated `PICA.py` to reflect versioning.
+
+---
+
+### Version 13.8
+*Released: October 09, 2025*
+
+**Build System & Documentation Overhaul**
+-   **New Build System:** Introduced `Picachu.py` for creating standalone Windows executables via Nuitka.
+-   **Automated Releases:** Implemented GitHub Actions `build-exe.yml` for automated compilation.
+-   **Build Script Refinements:** Optimized `resource_path` for bundled assets.
+
+---
+
+### Version 13.7
+*Released: October 08, 2025*
+
+**GUI Standardization & Modernization**
+-   **Major UI/UX Overhaul:** Refactored key frontends (Delta Mode R-T, High-Resistance R-T, Lakeshore Control) to align with the modern, dark-themed UI standard.
+-   **Backend Refinements:** Updated `IV_K6517B_L350_T_Control_Backend_v6.py` and `T_Control_L350_Simple_Backend_v10.py` with improved stability logic.
+
+---
+
+### Version 13.6
+*Released: October 07, 2025*
+
+**New Measurement GUIs & UI Standardization**
+-   **New LCR C-V GUI:** Integrated `CV_KE4980A_GUI_v2.py`.
+-   **New K2400/2182 Suites:** Added standardized I-V and R-T frontends.
+-   **UI/UX Overhaul:** Standardized all new frontends with a consistent dark-themed design.
+
+---
+
+### Version 13.5
+*Released: October 06, 2025*
+
+**Project-Wide Refactoring**
+-   **Major Refactoring:** Reorganized all scripts into instrument-specific folders (e.g., `Keithley_2400`, `Delta_mode_Keithley_6221_2182`).
+-   **New Structure:** Separated logic into `Backends` and `GUI` sub-folders.
+
+---
+
+### Version 13.4
+*Released: October 05, 2025*
+
+**PICA Launcher & Script Integration**
+-   **Enhancement:** Upgraded to `PICA.py` with a two-column layout.
+-   **New Feature:** Integrated markdown documentation viewer and automatic GPIB/VISA scanner.
+
+---
+
+### Version 13.3
+*Released: October 05, 2025*
+
+-   **Enhancement:** Updated launcher to distinguish between "Active" and "Passive" R-T modes.
+-   **New Scripts:** Integrated specialized scripts for Keithley 2400 R-T measurements.
+
+---
+
+### Version 13.2
+*Released: October 05, 2025*
+
+-   **Enhancement:** Integrated new professional frontends for the Keithley 2400/2182 measurement suite.
+
+---
+
+### Version 13.1
+*Released: October 04, 2025*
+
+-   **Enhancement:** Validated `Delta_Mode_Active_Temp_Control_V2.py` and `Delta_Mode_IV_Ambient.py`.
+
+---
+
+### Version 13.0 (Delta Mode Milestone)
+*Released: October 03, 2025*
+
+-   **New Program:** Developed `Delta_Mode_Active_Temp_Control.py` for automated temperature ramping.
+-   **New Program:** Created `Delta_Mode_IV_Ambient.py`.
+
+---
+## Historical Development Archive
+
+> **Note on Project Origins:**
+> The PICA software suite underwent an extensive offline development phase on isolated laboratory instrument control systems before its full migration to GitHub. The timeline below reconstructs the development history from raw commit logs and code diffs.
+
+### Phase 3: Expansion & Refinement (Sept 2025)
+*Focus on High Resistance & Temperature Control*
+-   **Sep 18, 2025:** Refined backend logic for High-Resistance Module (6517B).
+-   **Sep 17, 2025:** Developed comprehensive front-end/back-end for High-Resistance R vs. T. Integrated linearized drivers for Lakeshore 350.
+-   **Sep 10, 2025:** Major cleanup of `IV_Measurement` scripts and creation of `Lockin_Only.py`.
+-   **Sep 06, 2025:** **First Major Refactor.** Reorganized loose scripts into categorized folders (`IV_2400_Only`, `Pyroelectricity`, `Temprature_Controller`).
+
+### Phase 2: Modularization (July - Aug 2024)
+*Transitioning from Scripts to Modules*
+-   **Aug 15, 2024:** Added `Lakeshore_340_Continue_test.py` to support the older Lakeshore 340 model.
+-   **July 27, 2024:** **Structural reorganization.** Moved root-level scripts into categorized folders (`Pyroelectricity`, `LCR Keysight E 4980 A`). Renamed `Keithley_6517B.py` to `Pyroelectricity/Keithley_6517B.py`.
+
+### Phase 1: The "Bulk Upload" Era (Mar 2024)
+*Migration of Offline Work*
+-   **Mar 22, 2024:** Added Poling capabilities (`Poling_Keithley6517B.py`).
+-   **Mar 12, 2024:** Updates to `IV_Measurement.py` and `IV_Combine_2400-2182.py` logic.
+-   **Mar 11, 2024:** **Massive Feature Commit.** Added `LCR_CV.py` (Capacitance-Voltage), `Live_Data_Final-pyro.py`, and `IV_Measurement.py`.
+-   **Mar 03, 2024:** **Core Drivers Added.** Initial upload of `Keithley_6517B.py`, `Lakeshore350.py`, and `Pyroelectric.py` drivers. This marks the end of the first major offline development block.
+
+### Phase 0: Implementation & Testing (Dec 2023)
+*Proof of Concept & Raw SCPI Implementation*
+-   **Dec 09, 2023:** Updates to `IV_Front_End.py` and `README`.
+-   **Dec 08, 2023:** **Project Birth (Version Control).**
+    -   *Commit:* `963c8fd` - "Create Combine_2400-2182.py".
+    -   *Technical Detail:* This initial script implemented raw SCPI buffer operations (`trace:data?`, `assert_trigger`).
+    -   *Commit:* `f45dba8` - "Create GPIB_TEST.py". Established the first connectivity test for instrument communication.
+
+### Phase -1: Inception & Feasibility (June 2022)
+*Concept, Learning, and Prototyping*
+-   **June 10, 2022:** **First Tangible Prototype.** Initial proof-of-concept scripts for I-V characterization and shared ("Emailing code for IV.pdf"). This marked the validation of the Python-based control approach before formal development began.
+-   **June 09, 2022:** **Environment Setup & Skill Acquisition.** Due to the air-gapped nature of the laboratory computers, the initial Python environment was established by manually downloading dependencies (PyVISA, NumPy, Matplotlib) and installing them offline. This phase involved guided learning of instrument control concepts (e.g., "Python in Origin", SCPI basics) alongside specific training provided by the PI.
+
+-   **Collaboration Note:** The project's realization was significantly aided by colleagues (from UGC-DAE CSR,Mumbai) who assisted in rectifying technical issues and developing the necessary cryogenic probes and hardware fixtures required for measurements.
+-   **June 2022:** **Project Ideation.** Dr. Sudip Mukherjee (Principal Investigator) proposed the initiative for laboratory automation from manual methods to Python-based control. He provided critical roadmap materials, including reference videos, instrument handling protocols, and conceptual designs for the GUI layouts and hardware integration.

pica_suite-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,133 @@
+# Contributing to PICA
+
+First of all, thank you for considering contributing to PICA. With support from the community, we can create an open-source tool for scientific measurement and instrument automation to use instead of costly proprietary licensed software.
+
+# Building a Collaborative Ecosystem
+
+PICA is distributed under the permissive [MIT License](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/blob/main/LICENSE) because we believe scientific software should be a dynamic, living project rather than a static tool. Our goal is to foster a community-driven ecosystem where researchers are free to modify and extend the codebase to support their specific instruments.
+
+We designed PICA with a modular architecture specifically to make this process straightforward preventing the redundant effort of rewriting automation scripts from scratch. By contributing your custom drivers or experimental protocols back to the project via GitHub Pull Requests, you help create a more robust and versatile tool for the entire scientific community. Additionally, we rely on community feedback via GitHub Issues to identify edge cases and resolve bugs across diverse hardware setups, accelerating development far beyond what a single team could achieve.
+
+# Commitment to Transparency & Reproducibility
+
+Beyond practical utility, making PICA open source is a statement of scientific integrity. Unlike proprietary "black box" software that obscures experimental methodology, PICA ensures complete transparency. By accessing the full source code, researchers can audit the exact SCPI command sequences, timing delays, and data handling procedures used in an experiment. This methodological clarity is essential for rigorous validation and reproducibility in modern experimental science.
+
+## How to Report Bugs
+
+If you encounter a bug, please help us by reporting it. A well-reported bug significantly speeds up the resolution process. Before opening a new issue, please check if a similar issue already exists.
+
+When reporting a bug, please include as much detail as possible:
+
+*   **Steps to reproduce:** Clearly describe how to trigger the bug.
+*   **Expected behavior:** What did you expect to happen?
+*   **Actual behavior:** What actually happened?
+*   **PICA version:** Specify the [version](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/releases) of PICA you are using.
+*   **Operating system:** Your OS and version (e.g., Windows 10, Ubuntu 20.04).
+*   **Hardware setup:** Briefly describe your instrument setup if relevant.
+*   **Error messages/logs:** Include any relevant error messages or console output.
+
+You can use the [bug report issue template](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D) to ensure you provide all necessary information.
+
+## Contributing Code
+
+If this is something you think you can fix, then [fork PICA](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/fork) and create a branch with a descriptive name.
+
+A good branch name would be:
+
+```sh
+git checkout -b feature/add-new-instrument
+```
+
+### Get the test suite running
+
+Make sure you're running the [test suite locally](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/blob/main/docs/User_Manual.md#34-development-dependencies-for-testing-optional). It's a good idea to do this before you start making changes to ensure that everything is working correctly.
+
+### Coding Style Guide
+
+PICA adheres to [PEP 8](https://www.python.org/dev/peps/pep-0008/) for Python code style. Please ensure your contributions follow these guidelines. You can use tools like `flake8` or `black` to help format your code.
+
+### Implement your fix or feature
+
+At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first:
+
+### Make a Pull Request
+
+Once you've made your changes and tested them locally, you're ready to create a Pull Request (PR). A good PR makes it easy for maintainers to understand and review your changes. Please include:
+
+*   **A clear and concise title:** Summarize the main purpose of your PR.
+*   **Detailed description:** Explain the problem your PR solves, how you solved it, and any significant design decisions.
+*   **References to issues:** Link to any related issues (e.g., "Fixes #123" or "Closes #456").
+*   **Testing done:** Describe how you tested your changes.
+
+At this point, you should switch back to your main branch and make sure it's up to date with the latest upstream version of PICA.
+
+```sh
+git remote add upstream git@github.com:prathameshnium/PICA-Python-Instrument-Control-and-Automation.git
+git checkout main
+git pull upstream main
+```
+
+Then update your feature branch from your local copy of main, and push it!
+
+```sh
+git checkout feature/add-new-instrument
+git rebase main
+git push --force-with-lease origin feature/add-new-instrument
+```
+
+Finally, go to GitHub and [make a Pull Request](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/pulls)
+
+### Keeping your Pull Request updated
+
+If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
+
+To learn more about rebasing and merging, check out this guide from Atlassian:
+[https://www.atlassian.com/git/tutorials/merging-vs-rebasing](https://www.atlassian.com/git/tutorials/merging-vs-rebasing)
+
+### Adding a New Instrument Module
+
+One of the most important contributions you can make is to add support for new instruments. The architecture was designed to make this process straightforward by following a set of well-defined steps. Essentially, these are the same steps the original developers followed when adding new modules.
+
+#### Understanding the Architecture
+Code duplication is considered acceptable to avoid over-abstraction, which can make the project harder to maintain.
+
+#### Start with a Template
+
+The easiest way to start is to copy an existing module that is closest to your task or has the functionality you need.
+
+#### 1. Create New Files
+
+1.  Create a new directory for your instrument under the appropriate vendor (e.g., `pica/new_vendor/my_instrument/`).
+2.  Paste the copied files into this new directory.
+3.  Rename the files to reflect your new module (e.g., `IV_ABC_Instrument_GUI.py` and `IV_ABC_Instrument_Control.py`).
+
+#### 2. Implement the Instrument Control Logic
+
+Start with the basic instrument communication, then add measurement protocols, data saving, and plotting. Ensure that instrument communication (handled by `PyVISA` or `pymeasure`) uses the correct SCPI commands,  Replace the existing SCPI commands (e.g. `:SOUR:VOLT`, `:MEAS:CURR?`) with the commands specific to your instrument.. Your instrument's programming manual is the definitive source for these commands.Adjust the data parsing logic to handle the output format of your instrument.
+
+#### 3. Modify the GUI (`..._GUI.py`)
+
+1.  Open your new `..._GUI.py` file.
+2.  Update the `Tkinter` widgets (labels, entry boxes, dropdowns) to match the parameters required for your instrument (e.g., voltage range, compliance, measurement speed).
+3.  Ensure the "Start" button calls your new control logic (copy the logic from Instrument_Control file to here), passing the necessary parameters from the GUI.
+
+#### 4. Integrate into the PICA Launcher
+
+To make your new module accessible from the main dashboard:
+
+1.  Open `pica/main.py`.
+2.  Find the section where the instrument buttons are created (search for a `tk.Button` that launches an existing module).
+3.  Add a new `tk.Button` for your module. The button's `command` should be a function that launches your new `..._GUI.py` script. You can model this on the existing launcher functions.
+
+#### 5. Test and Document
+
+- Run your new module standalone and from the PICA launcher to ensure it works as expected. Test edge cases. It's often helpful to have a new user try it, as they can often find bugs you might have missed.
+- Consider adding a section for your new instrument in `docs/User_Manual.md` and adding a screenshot to `pica/assets/Images/screenshots/`.
+
+## Support
+
+For any questions, support, or assistance, please open a GitHub Issue in the main repository. This is the preferred and primary method for getting in touch with the development team and community for support.
+
+## Code of Conduct
+
+Everyone interacting in the PICA project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [PICA Code of Conduct](CODE_OF_CONDUCT.md).

pica_suite-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Prathamesh Deshmukh, Dr. Sudip Mukherjee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pica_suite-1.0.0/MANIFEST.in

@@ -0,0 +1,9 @@
+recursive-include pica/assets *
+recursive-include pica *.py
+
+# Include top-level documentation and legal files that are copied into the pica package
+include pica/README.md
+include pica/LICENSE
+include pica/CHANGELOG.md
+include pica/CONTRIBUTING.md
+recursive-include pica/docs *