Skip to content

Commit ea986dc

Browse files
minor corrections
1 parent 4bd0cf4 commit ea986dc

7 files changed

Lines changed: 31 additions & 62 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ First off, thank you for considering contributing to PICA! It's people like you
44

55
## Where do I go from here?
66

7-
If you've noticed a bug or have a feature request, [make one](https://github.com/Ketan-Anand/PICA-Python-Instrument-Control-and-Automation/issues/new)! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.
7+
If you've noticed a bug or have a feature request, [make one](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/issues/new)! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.
88

99
### Fork & create a branch
1010

11-
If this is something you think you can fix, then [fork PICA](https://github.com/Ketan-Anand/PICA-Python-Instrument-Control-and-Automation/fork) and create a branch with a descriptive name.
11+
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.
1212

1313
A good branch name would be (where issue #325 is the ticket you're working on):
1414

@@ -29,7 +29,7 @@ At this point, you're ready to make your changes! Feel free to ask for help; eve
2929
At this point, you should switch back to your master branch and make sure it's up to date with the latest upstream version of PICA.
3030

3131
```sh
32-
git remote add upstream git@github.com:Ketan-Anand/PICA-Python-Instrument-Control-and-Automation.git
32+
git remote add upstream git@github.com:prathameshnium/PICA-Python-Instrument-Control-and-Automation.git
3333
git checkout master
3434
git pull upstream master
3535
```
@@ -42,7 +42,7 @@ git rebase master
4242
git push --force-with-lease origin 325-add-japanese-translations
4343
```
4444

45-
Finally, go to GitHub and [make a Pull Request](https://github.com/Ketan-Anand/PICA-Python-Instrument-Control-and-Automation/compare)
45+
Finally, go to GitHub and [make a Pull Request](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/compare)
4646

4747
### Keeping your Pull Request updated
4848

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ PICA is structured as a standard Python package.
9191
```bash
9292
python -m venv venv
9393
# Activate venv (Windows: venv\Scripts\activate, Linux/Mac: source venv/bin/activate)
94-
pip install -r requirements.txt
94+
pip install .
9595
```
9696

9797
*Note: Ensure you have the NI-VISA drivers installed on your host machine to allow `PyVISA` to communicate with the hardware.*
@@ -101,13 +101,13 @@ PICA is structured as a standard Python package.
101101
1. **Graphical Launcher (Recommended)**
102102
The central dashboard for accessing all modules, the plotter, and the scanner.
103103
```bash
104-
python run_pica.py
104+
pica-gui
105105
```
106106

107107
2. **Command Line Interface (CLI)**
108-
Legacy support for headless operation (e.g., Raspberry Pi).
108+
For headless operation (e.g., Raspberry Pi).
109109
```bash
110-
python pica_cli.py
110+
pica-cli
111111
```
112112

113113
<hr />

docs/User_Manual.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,5 @@ PICA (Root Directory)/
312312
utils/ <-- Core Utilities
313313
GPIB_Instrument_Scanner_GUI.py
314314
PlotterUtil_GUI.py
315-
LivePlotter.py
316315
tests/ <-- Automated Test Suite
317316
```

docs/project_paths_reference.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ PICA (Root Directory)/
129129
GPIB_Instrument_Scanner_GUI.py
130130
GPIB_Interface_Rescue_Simple_Instrument_Control_v2_.py
131131
GUI_Basic_Format.py
132-
LivePlotter.py
132+
133133
PlotterUtil_GUI.py
134134
__init__.py
135135
scripts/

pyproject.toml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
66
name = "pica-suite"
77
version = "17.0.0"
88
authors = [
9-
{ name="Prathamesh Deshmukh", email="prathamesh.deshmukh@example.com" },
9+
{ name="Prathamesh Deshmukh", email="prathameshnium@duck.com" },
1010
{ name="Sudip Mukherjee", email="sudipm@csr.res.in" },
1111
]
1212
description = "Python-based Instrument Control and Automation Suite"
@@ -19,13 +19,13 @@ classifiers = [
1919
"Topic :: Scientific/Engineering :: Physics",
2020
]
2121
dependencies = [ # Pinned to match requirements.txt for stability
22-
"numpy==1.22.4",
23-
"pandas==1.4.2",
24-
"matplotlib==3.5.2",
25-
"PyVISA==1.12.0",
26-
"PyMeasure==0.10.0",
27-
"pyvisa-py==0.5.3",
28-
"gpib-ctypes==0.3.0",
22+
"numpy>=1.22.4",
23+
"pandas>=1.4.2",
24+
"matplotlib>=3.5.2",
25+
"PyVISA>=1.12.0",
26+
"PyMeasure>=0.10.0",
27+
"pyvisa-py>=0.5.3",
28+
"gpib-ctypes>=0.3.0",
2929
"scipy" # Scipy is flexible enough to work with the older numpy
3030
]
3131

@@ -46,4 +46,8 @@ testpaths = [
4646
]
4747
pythonpath = [
4848
".",
49-
]
49+
]
50+
51+
[project.scripts]
52+
pica-gui = "pica.main:main"
53+
pica-cli = "pica.cli:main"

requirements.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
numpy==1.22.4
2-
pandas==1.4.2
3-
matplotlib==3.5.2
4-
pymeasure==0.10.0
5-
pyvisa==1.12.0
6-
pyvisa-py==0.5.3
7-
gpib-ctypes==0.3.0
8-
pillow~=10.3.0
1+
numpy>=1.22.4
2+
pandas>=1.4.2
3+
matplotlib>=3.5.2
4+
pymeasure>=0.10.0
5+
pyvisa>=1.12.0
6+
pyvisa-py>=0.5.3
7+
gpib-ctypes>=0.3.0
8+
pillow>=10.3.0
99
freezegun
1010
pytest
1111
pytest-cov

tests/test_utilities_logic.py

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
22
Purpose: Logic checks for helper tools.
33
4-
What it does: Verifies that the LivePlotter correctly appends data to arrays and that formatting utilities define the correct fonts/styles.
4+
What it does: Verifies that formatting utilities define the correct fonts/styles.
55
"""
66
import pytest
77
from unittest.mock import MagicMock, patch
@@ -13,40 +13,6 @@
1313
if project_root not in sys.path:
1414
sys.path.insert(0, project_root)
1515

16-
def test_live_plotter_logic():
17-
"""
18-
Tests the LivePlotter class. We mock matplotlib, but we verify
19-
that the class handles data appending correctly.
20-
"""
21-
# Mock matplotlib so we don't need a screen
22-
with patch('matplotlib.pyplot.figure'), \
23-
patch('matplotlib.backends.backend_tkagg.FigureCanvasTkAgg'):
24-
25-
try:
26-
from pica.utils.LivePlotter import LivePlotter
27-
except ImportError:
28-
pytest.skip("Could not import LivePlotter.")
29-
30-
# Instantiate
31-
mock_root = MagicMock()
32-
plotter = LivePlotter(mock_root)
33-
34-
# Test 1: Check initial state
35-
assert hasattr(plotter, 'x_data')
36-
assert hasattr(plotter, 'y_data')
37-
assert len(plotter.x_data) == 0
38-
39-
# Test 2: Update Logic (The most important part)
40-
# We simulate adding a data point
41-
plotter.update_plot(1.0, 10.5)
42-
43-
# Verify data was stored (This proves the logic works)
44-
assert len(plotter.x_data) == 1
45-
assert len(plotter.y_data) == 1
46-
assert plotter.x_data[0] == 1.0
47-
assert plotter.y_data[0] == 10.5
48-
print("\n[Utilities] LivePlotter data appending logic verified.")
49-
5016
def test_gui_basic_formatter():
5117
"""
5218
Tests the GUI_Basic_Format module.

0 commit comments

Comments
 (0)