Skip to content

Commit 3a653da

Browse files
Update Read the Docs installation guide with quick-start steps
Agent-Logs-Url: https://github.com/MShirazAhmad/PhysPlot/sessions/74ef9cc9-fee4-43ef-8bf4-3e4bd95f0057 Co-authored-by: MShirazAhmad <35538879+MShirazAhmad@users.noreply.github.com>
1 parent 4afc10b commit 3a653da

1 file changed

Lines changed: 32 additions & 6 deletions

File tree

docs/installation.rst

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,40 @@ Prerequisites
77
- Python 3.7 or newer
88
- pip
99

10-
Usage modes
11-
-----------
10+
Clone the repository
11+
--------------------
1212

13-
PhysPlot is available in two common modes:
13+
.. code-block:: bash
14+
15+
git clone https://github.com/MShirazAhmad/PhysPlot.git
16+
cd PhysPlot
17+
18+
Create and activate a virtual environment
19+
-----------------------------------------
20+
21+
.. code-block:: bash
22+
23+
python -m venv .venv
24+
25+
On macOS/Linux:
26+
27+
.. code-block:: bash
28+
29+
source .venv/bin/activate
30+
31+
On Windows (PowerShell):
32+
33+
.. code-block:: powershell
1434
15-
1. Packaged desktop builds when provided by the official PhysPlot project.
16-
2. Python script execution using ``PhysPlot.py``.
35+
.venv\Scripts\Activate.ps1
1736
1837
Install Python dependencies
1938
---------------------------
2039

2140
.. code-block:: bash
2241
23-
pip install PyQt5 matplotlib numpy scipy pandas
42+
python -m pip install --upgrade pip
43+
python -m pip install -r requirements.txt
2444
2545
Run PhysPlot
2646
------------
@@ -31,5 +51,11 @@ From the project directory:
3151
3252
python PhysPlot.py
3353
54+
Alternative module entry point:
55+
56+
.. code-block:: bash
57+
58+
python -m physplot
59+
3460
Keep the ``physplot/inc`` image assets with the source tree so the GUI can load
3561
the official app icon and logo.

0 commit comments

Comments
 (0)