Skip to content

Commit 238d322

Browse files
images path updated
1 parent 66cbc5e commit 238d322

2 files changed

Lines changed: 29 additions & 20 deletions

File tree

docs/User_Manual.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
---
66

77
:::{note}
8-
🎉 **v1.0.4 is now live!** The GUI has been refreshed with a new Latte theme lighter, warmer, and easier on the eyes during long measurement sessions. Install or upgrade via pip:
8+
**v1.0.4 is now live!** The GUI has been refreshed with a new Latte theme lighter, warmer, and easier on the eyes during long measurement sessions. Install or upgrade via pip:
99

1010
```bash
1111
pip install --upgrade pica-suite
@@ -226,7 +226,7 @@ Automatically launched upon startup (and accessible within modules), this utilit
226226
227227
In the main PICA launcher, the VISA/GPIB scanner is configured to execute automatically at application startup. This design choice is motivated by the fact that initiating a measurement without first verifying the instrument connection is highly likely to fail and may result in non-informative error messages, such as a VISA connection timeout.
228228
229-
:::{figure} ../pica/assets/Images/screenshots/01_GPIB_Scanner.png
229+
:::{figure} Images/screenshots/01_GPIB_Scanner.png
230230
:alt: GPIB Scanner
231231
:width: 300px
232232
:align: center
@@ -244,7 +244,7 @@ A standalone, multiprocessing-enabled tool for detailed data analysis. Unlike th
244244
* **Live Updates:** Monitoring active experiments by auto-refreshing data from disk.
245245
* **Flexible Axis Control:** Toggling linear/log scales to analyze data spanning orders of magnitude.
246246
247-
:::{figure} ../pica/assets/Images/screenshots/02_Plotter_Utility.png
247+
:::{figure} Images/screenshots/02_Plotter_Utility.png
248248
:alt: Plotter Utility
249249
:width: 600px
250250
:align: center
@@ -302,23 +302,23 @@ impedance analyzer enables the characterization of capacitance anomalies over th
302302
The software synchronizes the source and voltmeter via a **hardware trigger link (RS-232)** for microsecond-level timing.
303303
:::
304304
305-
:::{figure} ../pica/assets/Images/screenshots/K6221_IV_Sweep.png
305+
:::{figure} Images/screenshots/K6221_IV_Sweep.png
306306
:alt: Delta Mode IV Sweep
307307
:width: 600px
308308
:align: center
309309
310310
I-V sweep measurement using the Sweep Mode, designed for low-resistance measurements with a Keithley 6221 and 2182.
311311
:::
312312
313-
:::{figure} ../pica/assets/Images/screenshots/K6221_RT_Control.png
313+
:::{figure} Images/screenshots/K6221_RT_Control.png
314314
:alt: Delta Mode RT Control
315315
:width: 600px
316316
:align: center
317317
318318
Ultra Low Resistance Measurement R-T measurement with active temperature control, using a Keithley 6221, K2182, and a temperature controller.
319319
:::
320320
321-
:::{figure} ../pica/assets/Images/screenshots/K6221_RT_Sensing.png
321+
:::{figure} Images/screenshots/K6221_RT_Sensing.png
322322
:alt: Delta Mode RT Sensing
323323
:width: 600px
324324
:align: center
@@ -336,23 +336,23 @@ Ultra Low Resistance Measurement R-T measurement in sensing mode, where the syst
336336
* **I-V Sweep:** Linear sweeps, hysteresis loops, or custom current lists.
337337
* **R-T Active Control:** Applies constant DC current while coordinating with a temperature controller (e.g., Lake Shore 350) to ramp temperature.
338338
339-
:::{figure} ../pica/assets/Images/screenshots/K2400_IV_Sweep.png
339+
:::{figure} Images/screenshots/K2400_IV_Sweep.png
340340
:alt: K2400 IV Sweep
341341
:width: 600px
342342
:align: center
343343
344344
A standard I-V sweep performed with a Keithley 2400 SourceMeter, suitable for general-purpose device and sample characterization.
345345
:::
346346
347-
:::{figure} ../pica/assets/Images/screenshots/K2400_RT_Control.png
347+
:::{figure} Images/screenshots/K2400_RT_Control.png
348348
:alt: K2400 RT Control
349349
:width: 600px
350350
:align: center
351351
352352
Resistance-Temperature (R-T) measurement with active temperature control, using a Keithley 2400 and a Lakeshore 350 controller.
353353
:::
354354
355-
:::{figure} ../pica/assets/Images/screenshots/K2400_RT_Sensing.png
355+
:::{figure} Images/screenshots/K2400_RT_Sensing.png
356356
:alt: K2400 RT Sensing
357357
:width: 600px
358358
:align: center
@@ -368,23 +368,23 @@ Resistance-Temperature (R-T) measurement in sensing mode, where the system logs
368368
* **Scientific Objective:** Detects subtle phase transitions in semiconductors and oxides where standard SMU resolution is insufficient.
369369
* **Advantage:** Combines the stable sourcing of the SMU with the nanovolt-level sensitivity of a dedicated voltmeter, utilizing a true 4-wire configuration to eliminate lead resistance errors.
370370
371-
:::{figure} ../pica/assets/Images/screenshots/K2400_2182_IV.png
371+
:::{figure} Images/screenshots/K2400_2182_IV.png
372372
:alt: K2400_2182 IV
373373
:width: 600px
374374
:align: center
375375
376376
High-precision I-V characterization using a Keithley 2400 as a current source and a Keithley 2182 nanovoltmeter for sensitive mid-range resistance measurements.
377377
:::
378378
379-
:::{figure} ../pica/assets/Images/screenshots/K2400_2182_RT_Control.png
379+
:::{figure} Images/screenshots/K2400_2182_RT_Control.png
380380
:alt: K2400 2182 RT Control
381381
:width: 600px
382382
:align: center
383383
384384
High-precision R-T measurement with active temperature control, combining the K2400, K2182, and a L350 temperature controller.
385385
:::
386386
387-
:::{figure} ../pica/assets/Images/screenshots/K2400_2182_RT_Sensing.png
387+
:::{figure} Images/screenshots/K2400_2182_RT_Sensing.png
388388
:alt: K2400 2182 RT Sensing
389389
:width: 600px
390390
:align: center
@@ -403,23 +403,23 @@ High-precision R-T measurement in sensing mode, leveraging the K2400 and K2182 f
403403
404404
**A screencast demonstrating the high resistance IV module is available at [this link](https://drive.google.com/file/d/13W-Z4N-08t9m0xxuR30sjTLmUVG1VyQd/view?usp=sharing).**
405405
406-
:::{figure} ../pica/assets/Images/screenshots/K6517B_IV.png
406+
:::{figure} Images/screenshots/K6517B_IV.png
407407
:alt: K6517B IV
408408
:width: 600px
409409
:align: center
410410
411411
High-resistance I-V measurement performed with a Keithley 6517B Electrometer, designed for characterizing insulating materials.
412412
:::
413413
414-
:::{figure} ../pica/assets/Images/screenshots/K6517B_RT_Control.png
414+
:::{figure} Images/screenshots/K6517B_RT_Control.png
415415
:alt: K6517B RT Control
416416
:width: 600px
417417
:align: center
418418
419419
High-resistance R-T measurement with active temperature control using a Keithley 6517B.
420420
:::
421421
422-
:::{figure} ../pica/assets/Images/screenshots/K6517B_RT_Sensing.png
422+
:::{figure} Images/screenshots/K6517B_RT_Sensing.png
423423
:alt: K6517B RT Sensing
424424
:width: 600px
425425
:align: center
@@ -440,7 +440,7 @@ This module automates the measurement of pyroelectric currents (Ip) as a functio
440440
3. **Measurement:** Record the depolarization current peak indicative of phase transition.
441441
* **Best Practice:** For measurements in the fA range, ensure your setup utilises proper shielding (e.g., double-layer Faraday cage).
442442
443-
:::{figure} ../pica/assets/Images/screenshots/Pyroelectric_Current.png
443+
:::{figure} Images/screenshots/Pyroelectric_Current.png
444444
:alt: Pyroelectric Current
445445
:width: 600px
446446
:align: center
@@ -466,7 +466,7 @@ This utility provides a dedicated interface for **In-situ and ex-situ electrical
466466
467467
* **Scientific Objective:** Measures Capacitance (C) and Loss Tangent (tan delta) as a function of frequency or DC bias voltage (C-V Analysis).
468468
469-
:::{figure} ../pica/assets/Images/screenshots/Keysight_CV.png
469+
:::{figure} Images/screenshots/Keysight_CV.png
470470
:alt: Keysight CV
471471
:width: 600px
472472
:align: center
@@ -483,15 +483,15 @@ PICA also includes standalone utilities for monitoring and controlling temperatu
483483
* **Temperature Monitor:** A simple interface for logging temperature from multiple types of sensors.
484484
* **Temperature Control:** A dedicated module for setting temperature ramps, controlling heater outputs, and managing control loops.
485485
486-
:::{figure} ../pica/assets/Images/screenshots/Lakeshore_Temp_Monitor.png
486+
:::{figure} Images/screenshots/Lakeshore_Temp_Monitor.png
487487
:alt: Lakeshore Temp Monitor
488488
:width: 600px
489489
:align: center
490490
491491
The standalone Temperature Monitor utility, used for logging data from a Lakeshore 350 controller.
492492
:::
493493
494-
:::{figure} ../pica/assets/Images/screenshots/Lakeshore_Temp_Control.png
494+
:::{figure} Images/screenshots/Lakeshore_Temp_Control.png
495495
:alt: Lakeshore Temp Control
496496
:width: 600px
497497
:align: center
@@ -632,7 +632,7 @@ The procedure for adding a new instrument module to PICA is described in the [CO
632632
633633
## 13. Authors & Acknowledgments
634634
635-
:::{figure} ../pica/assets/LOGO/UGC_DAE_CSR_NBG.jpeg
635+
:::{figure} LOGO/UGC_DAE_CSR_NBG.jpeg
636636
:alt: UGC DAE CSR Logo
637637
:width: 150px
638638
:align: center

docs/conf.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# docs/conf.py
22

3+
# Make Sphinx aware of the repo root so relative paths resolve
4+
import os
5+
import sys
6+
sys.path.insert(0, os.path.abspath('..'))
7+
38
# -- Project information -----------------------------------------------------
49
project = 'PICA'
510
copyright = '2026, Prathamesh Deshmukh'
@@ -15,6 +20,7 @@
1520
# Configure MyST-Parser to allow HTML images (the <img src="..."> tags in your manual)
1621
myst_enable_extensions = [
1722
"html_image",
23+
"colon_fence",
1824
]
1925

2026
# Map file extensions to the parser
@@ -32,6 +38,9 @@
3238
# Add any paths that contain custom static files (such as style sheets)
3339
html_static_path = ['_static']
3440

41+
# This copies the pica/assets folder into the build output
42+
html_extra_path = ["../pica/assets"]
43+
3544
# This ensures Sphinx doesn't complain about the pica folder
3645
# we manually move in the workflow
3746
suppress_warnings = ['image.not_readable']

0 commit comments

Comments
 (0)