Large restructure_project

prathameshnium · prathameshnium · commit 07d7c2172b03 · 2025-12-02T14:26:54.000+05:30
diff --git a/pica/__init__.py b/pica/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for pica
diff --git a/pica/__pycache__/__init__.cpython-310.pyc b/pica/__pycache__/__init__.cpython-310.pyc
diff --git a/pica/__pycache__/main.cpython-310.pyc b/pica/__pycache__/main.cpython-310.pyc
diff --git a/pica/assets/Images/__init__.py b/pica/assets/Images/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Images
diff --git a/pica/assets/LOGO/__init__.py b/pica/assets/LOGO/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for LOGO
diff --git a/pica/assets/Manuals/__init__.py b/pica/assets/Manuals/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Manuals
diff --git a/pica/assets/__init__.py b/pica/assets/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for assets
diff --git a/pica/keithley/__init__.py b/pica/keithley/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for keithley
diff --git a/pica/keithley/delta_mode/Instrument_Control/__init__.py b/pica/keithley/delta_mode/Instrument_Control/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Instrument_Control
diff --git a/pica/keithley/delta_mode/__init__.py b/pica/keithley/delta_mode/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for delta_mode
diff --git a/pica/keithley/k2400/Instrument_Control/__init__.py b/pica/keithley/k2400/Instrument_Control/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Instrument_Control
diff --git a/pica/keithley/k2400/__init__.py b/pica/keithley/k2400/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for k2400
diff --git a/pica/keithley/k2400_2182/Instrument_Control/__init__.py b/pica/keithley/k2400_2182/Instrument_Control/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Instrument_Control
diff --git a/pica/keithley/k2400_2182/__init__.py b/pica/keithley/k2400_2182/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for k2400_2182
diff --git a/pica/keithley/k6517b/High_Resistance/Instrument_Control/__init__.py b/pica/keithley/k6517b/High_Resistance/Instrument_Control/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Instrument_Control
diff --git a/pica/keithley/k6517b/High_Resistance/__init__.py b/pica/keithley/k6517b/High_Resistance/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for High_Resistance
diff --git a/pica/keithley/k6517b/Pyroelectricity/Instrument_Control/__init__.py b/pica/keithley/k6517b/Pyroelectricity/Instrument_Control/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Instrument_Control
diff --git a/pica/keithley/k6517b/Pyroelectricity/__init__.py b/pica/keithley/k6517b/Pyroelectricity/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Pyroelectricity
diff --git a/pica/keithley/k6517b/__init__.py b/pica/keithley/k6517b/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for k6517b
diff --git a/pica/keysight/Instrument_Control/__init__.py b/pica/keysight/Instrument_Control/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Instrument_Control
diff --git a/pica/keysight/__init__.py b/pica/keysight/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for keysight
diff --git a/pica/lakeshore/Instrument_Control/__init__.py b/pica/lakeshore/Instrument_Control/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for Instrument_Control
diff --git a/pica/lakeshore/__init__.py b/pica/lakeshore/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for lakeshore
diff --git a/pica/lockin/__init__.py b/pica/lockin/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for lockin
diff --git a/pica/utils/__init__.py b/pica/utils/__init__.py
@@ -0,0 +1 @@
+# Auto-generated package init for utils
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,48 +1,72 @@
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
+requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "pica-automation"
-version = "1.0.0"
+name = "pica-suite"
+version = "1.0.1"
 authors = [
-    { name = "Prathamesh Deshmukh", email = "prathameshium@duck.com" },
+  { name="Prathamesh Deshmukh", email="prathamesh.deshmukh@example.com" },
+  { name="Sudip Mukherjee", email="sudipm@csr.res.in" },
 ]
-description = "A modular software suite for automating laboratory measurements in physics research."
+description = "Python-based Instrument Control and Automation Suite"
 readme = "README.md"
-license = { file = "LICENSE" }
 requires-python = ">=3.10"
 classifiers = [
-    "Development Status :: 4 - Beta",
-    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
     "Topic :: Scientific/Engineering :: Physics",
-    "Topic :: System :: Hardware :: Hardware Drivers",
 ]
 dependencies = [
-    "pyvisa",
-    "pyvisa-py",
     "numpy",
-    "matplotlib",
     "pandas",
-    "pymeasure",
-    "Pillow", # For image handling in GUIs
-    "gpib-ctypes" # Provides a mockable GPIB backend for CI/testing
+    "matplotlib",
+    "PyVISA",
+    "PyMeasure",
+    "pyvisa-py",
+    "scipy"
 ]
 
 [project.urls]
 "Homepage" = "https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation"
 "Bug Tracker" = "https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/issues"
 
-[project.gui-scripts]
-pica-launcher = "PICA:main"
-
-# --- CRITICAL CONFIGURATION FOR YOUR FOLDER STRUCTURE ---
+# This finds the new 'pica' folder automatically
 [tool.setuptools.packages.find]
-where = ["."]  # Tells pip your code is in the root, not 'src'
-include = ["*"]  # Explicitly includes all subfolders (Keithley_2400, Utilities, etc.)
-exclude = ["tests*", "_assets*", "Setup*"]  # Excludes non-code assets from the installed package
+where = ["."]
+include = ["pica*"]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"
+testpaths = [
+    "tests",
+]
+pythonpath = [
+    ".",
+]
+```
+
+#### Step 2: Fix Asset Paths in `pica/main.py`
+Since `main.py` is no longer in the root folder, it might not find the images (logos). Open `pica/main.py` and look for where `ASSET_PATH` or image paths are defined.
+
+Replace hardcoded paths like `"assets/"` with this dynamic path code:
+
+```python
+import os
+# Get the directory where this file resides (pica/)
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+# Build path to assets relative to this file
+ASSET_PATH = os.path.join(BASE_DIR, 'assets')
+```
+
+#### Step 3: Install & Test
+Run these commands in your terminal to register the new package structure and test it:
+
+```bash
+# 1. Install the package in "editable" mode
+pip install -e .
+
+# 2. Run the new launcher shim
+python run_pica.py
diff --git a/restructure_project.py b/restructure_project.py
@@ -0,0 +1,149 @@
+import os
+import shutil
+import subprocess
+import sys
+import re
+
+# Configuration: Mapping Old Paths to New Professional Paths
+# Format: "Old_Folder_Name": "new/path/inside/pica"
+MAPPING = {
+    "Keithley_2400": "pica/keithley/k2400",
+    "Keithley_6517B": "pica/keithley/k6517b",
+    "Keithley_2400_Keithley_2182": "pica/keithley/k2400_2182",
+    "Delta_mode_Keithley_6221_2182": "pica/keithley/delta_mode",
+    "Lakeshore_350_340": "pica/lakeshore",
+    "LCR_Keysight_E4980A": "pica/keysight",
+    "Lock_in_amplifier": "pica/lockin",
+    "Utilities": "pica/utils",
+    "assets": "pica/assets" # Assets often go inside the package for GUI access
+}
+
+ROOT_FILES_TO_MOVE = {
+    "PICA.py": "pica/main.py",
+    "clean_filenames.py": "scripts/clean_filenames.py"
+}
+
+def run_command(command):
+    """Runs a shell command."""
+    try:
+        subprocess.check_call(command, shell=True)
+    except subprocess.CalledProcessError as e:
+        print(f"Error running command: {command}")
+        sys.exit(1)
+
+def ensure_dir(path):
+    if not os.path.exists(path):
+        os.makedirs(path)
+
+def create_init_files(root_dir):
+    """Recursively creates __init__.py files to make directories packages."""
+    print("Creating __init__.py files...")
+    for dirpath, dirnames, filenames in os.walk(root_dir):
+        if "__init__.py" not in filenames:
+            with open(os.path.join(dirpath, "__init__.py"), 'w') as f:
+                f.write(f"# Auto-generated package init for {os.path.basename(dirpath)}\n")
+
+def update_imports(file_path):
+    """
+    Reads a python file and updates old import paths to new pica.* paths.
+    This is a regex-based 'best effort' refactor.
+    """
+    with open(file_path, 'r', encoding='utf-8') as f:
+        content = f.read()
+
+    original_content = content
+
+    # 1. Fix Utilities imports
+    content = re.sub(r'from Utilities', 'from pica.utils', content)
+    content = re.sub(r'import Utilities', 'import pica.utils', content)
+
+    # 2. Fix Keithley 2400 imports
+    content = re.sub(r'from Keithley_2400', 'from pica.keithley.k2400', content)
+    
+    # 3. Fix Lakeshore imports
+    content = re.sub(r'from Lakeshore_350_340', 'from pica.lakeshore', content)
+    
+    # 4. Fix Delta Mode imports
+    content = re.sub(r'from Delta_mode_Keithley_6221_2182', 'from pica.keithley.delta_mode', content)
+
+    # 5. Fix Keysight imports
+    content = re.sub(r'from LCR_Keysight_E4980A', 'from pica.keysight', content)
+
+    # 6. Fix generic "assets" paths in GUI code (assuming relative paths)
+    # This replaces "assets/" with dynamic path logic, but for now let's just update the string
+    # If the code uses strict relative paths, this might need manual checking.
+    
+    if content != original_content:
+        print(f"  [Refactoring] Updated imports in {file_path}")
+        with open(file_path, 'w', encoding='utf-8') as f:
+            f.write(content)
+
+def main():
+    print("--- Starting Professional PICA Refactoring ---")
+    
+    # 1. Create Base Directories
+    ensure_dir("pica")
+    ensure_dir("scripts")
+    
+    # Check if this is a git repo
+    is_git = os.path.exists(".git")
+    if is_git:
+        print("Git repository detected. Using 'git mv' to preserve history.")
+    else:
+        print("No git detected. Using standard file move.")
+
+    # 2. Move Folders based on Mapping
+    for old_name, new_path in MAPPING.items():
+        if os.path.exists(old_name):
+            print(f"Moving {old_name} -> {new_path}")
+            # Ensure parent dir exists
+            ensure_dir(os.path.dirname(new_path))
+            
+            if is_git:
+                # git mv expects the parent directory of destination to exist
+                run_command(f'git mv "{old_name}" "{new_path}"')
+            else:
+                shutil.move(old_name, new_path)
+        else:
+            print(f"Skipping {old_name} (Not found)")
+
+    # 3. Move Root Files
+    for old_file, new_path in ROOT_FILES_TO_MOVE.items():
+        if os.path.exists(old_file):
+            print(f"Moving {old_file} -> {new_path}")
+            ensure_dir(os.path.dirname(new_path))
+            if is_git:
+                run_command(f'git mv "{old_file}" "{new_path}"')
+            else:
+                shutil.move(old_file, new_path)
+
+    # 4. Create __init__.py files
+    create_init_files("pica")
+
+    # 5. Update Imports in all Python files
+    print("Scanning for import statements to update...")
+    for dirpath, _, filenames in os.walk("pica"):
+        for filename in filenames:
+            if filename.endswith(".py"):
+                update_imports(os.path.join(dirpath, filename))
+    
+    # Also check tests
+    if os.path.exists("tests"):
+        for dirpath, _, filenames in os.walk("tests"):
+            for filename in filenames:
+                if filename.endswith(".py"):
+                    update_imports(os.path.join(dirpath, filename))
+
+    # 6. Create a new Launcher at root (Shim)
+    print("Creating root-level launcher (run_pica.py)...")
+    with open("run_pica.py", "w") as f:
+        f.write("from pica.main import main\n\nif __name__ == '__main__':\n    main()\n")
+
+    print("\n--- Refactoring Complete ---")
+    print("1. Review the 'pica/' folder structure.")
+    print("2. Run 'pip install -e .' to install the package in editable mode.")
+    print("3. Try running 'python run_pica.py' to test.")
+    print("4. Run your tests: 'pytest'")
+
+if __name__ == "__main__":
+    main()
diff --git a/run_pica.py b/run_pica.py
@@ -0,0 +1,4 @@
+from pica.main import main
+
+if __name__ == '__main__':
+    main()
diff --git a/tests/test_backends_logic.py b/tests/test_backends_logic.py
@@ -43,7 +43,7 @@ def analyze_module_content(module):
 def test_lcr_backend_structure():
     with patch('pyvisa.ResourceManager'), patch('pyvisa.resources.MessageBasedResource'):
         try:
-            from LCR_Keysight_E4980A.Instrument_Control import CV_KE4980A_Simple_Instrument_Control as LCR_Module
+            from pica.keysight.Instrument_Control import CV_KE4980A_Simple_Instrument_Control as LCR_Module
         except ImportError:
             pytest.skip("Could not import LCR Instrument Control.")
 
@@ -68,7 +68,7 @@ def test_lcr_backend_structure():
 def test_delta_backend_structure():
     with patch('pyvisa.ResourceManager'):
         try:
-            from Delta_mode_Keithley_6221_2182.Instrument_Control import Delta_K6221_K2182_Simple as Delta_Module
+            from pica.keithley.delta_mode.Instrument_Control import Delta_K6221_K2182_Simple as Delta_Module
         except ImportError:
             pytest.skip("Could not import Delta Instrument Control.")
 
@@ -91,7 +91,7 @@ def test_delta_backend_structure():
 def test_k2400_backend_structure():
     with patch('pyvisa.ResourceManager'):
         try:
-            from Keithley_2400.Instrument_Control import IV_K2400_Loop_Instrument_Control as K2400_Module
+            from pica.keithley.k2400.Instrument_Control import IV_K2400_Loop_Instrument_Control as K2400_Module
         except ImportError:
             pytest.skip("Could not import Keithley 2400 Instrument Control.")
 
diff --git a/tests/test_deep_simulation.py b/tests/test_deep_simulation.py
@@ -254,7 +254,7 @@ def test_11_gpib_scanner(self):
             rm = MockRM.return_value
             rm.list_resources.return_value = ('GPIB0::24::INSTR',)
             try:
-                import Utilities.GPIB_Instrument_Scanner_GUI as scanner
+                import pica.utils.GPIB_Instrument_Scanner_GUI as scanner
                 if hasattr(scanner, 'GpibScannerGUI'):
                     print("   -> Verified: Import successful", flush=True)
             except ImportError:
diff --git a/tests/test_full_stack_simulation.py b/tests/test_full_stack_simulation.py
@@ -149,7 +149,7 @@ def test_gpib_scanner_loop(self):
                 'GPIB0::24::INSTR', 'GPIB0::12::INSTR')
 
             try:
-                import Utilities.GPIB_Instrument_Scanner_GUI as scanner
+                import pica.utils.GPIB_Instrument_Scanner_GUI as scanner
                 if hasattr(scanner, 'GPIBScannerWindow'):
                     scanner.GPIBScannerWindow(MagicMock(), MagicMock())
                     rm.list_resources.assert_called()
diff --git a/tests/test_utilities_logic.py b/tests/test_utilities_logic.py
@@ -23,7 +23,7 @@ def test_live_plotter_logic():
          patch('matplotlib.backends.backend_tkagg.FigureCanvasTkAgg'):
         
         try:
-            from Utilities.LivePlotter import LivePlotter
+            from pica.utils.LivePlotter import LivePlotter
         except ImportError:
             pytest.skip("Could not import LivePlotter.")
 
@@ -54,7 +54,7 @@ def test_gui_basic_formatter():
     """
     with patch('tkinter.font.Font', MagicMock()): # Mock font creation
         try:
-            import Utilities.GUI_Basic_Format as GUI_Format
+            import pica.utils.GUI_Basic_Format as GUI_Format
         except ImportError:
             pytest.skip("Could not import GUI_Basic_Format.")
             

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Auto-generated package init for Images`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Auto-generated package init for Manuals`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Auto-generated package init for assets`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Auto-generated package init for keithley`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Auto-generated package init for Instrument_Control`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Auto-generated package init for delta_mode`