Skip to content

Commit 3eac081

Browse files
above bare mini docs.md
1 parent 238d322 commit 3eac081

2 files changed

Lines changed: 47 additions & 6 deletions

File tree

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
project = 'PICA'
1010
copyright = '2026, Prathamesh Deshmukh'
1111
author = 'Prathamesh Deshmukh'
12-
release = '1.0.3'
12+
release = '1.0.4'
1313

1414
# -- General configuration ---------------------------------------------------
1515
extensions = [
@@ -43,4 +43,4 @@
4343

4444
# This ensures Sphinx doesn't complain about the pica folder
4545
# we manually move in the workflow
46-
suppress_warnings = ['image.not_readable']
46+
suppress_warnings = ["etoc.toctree"]

docs/index.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,50 @@
11
# PICA Documentation
22

3-
Welcome to the documentation for the Python Instrument Control and Automation (PICA) software.
3+
**Python Instrument Control and Automation**
4+
5+
[![GitHub Release](https://img.shields.io/github/v/release/prathameshnium/PICA-Python-Instrument-Control-and-Automation)](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/releases)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/blob/main/LICENSE)
7+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18377217.svg)](https://doi.org/10.5281/zenodo.18377217)
8+
[![Read the Docs](https://readthedocs.org/projects/pica-python-instrument-control-and-automation/badge/?version=latest)](https://pica-python-instrument-control-and-automation.readthedocs.io/en/latest/)
9+
10+
PICA is a modular, open-source Python suite for automating high-precision transport measurements. It supports a resistance range spanning **24 orders of magnitude** (10 nΩ – 10 PΩ), pyroelectric current detection down to 1 fA, and capacitance spectroscopy from 20 Hz – 2 MHz.
11+
12+
---
13+
14+
## Quick Start
15+
16+
```bash
17+
# Install
18+
pip install .
19+
20+
# Launch GUI
21+
pica-gui
22+
```
23+
24+
---
25+
26+
## Key Features
27+
28+
- **Unified GUI** — Single launcher for all measurement modules
29+
- **Wide resistance range** — 10 nΩ to 10 PΩ across four hardware configurations
30+
- **Real-time plotting** — Live visualization during acquisition
31+
- **Process isolation** — Backend crashes never affect the GUI
32+
- **Open source** — MIT licensed, fully auditable SCPI commands
433

5-
```{toctree}
634
---
7-
maxdepth: 2
35+
36+
## Getting Help
37+
38+
- [Full User Manual](User_Manual.md)
39+
- [GitHub Issues](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/issues)
40+
- [Releases](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/releases)
41+
- [Preprint](https://prathameshnium.github.io/PICA-Python-Instrument-Control-and-Automation/publications/)
42+
843
---
9-
User_Manual.md
44+
45+
```{toctree}
46+
:maxdepth: 2
47+
:caption: Contents
48+
49+
User_Manual
50+
```

0 commit comments

Comments
 (0)