Skip to content

Commit cca8e30

Browse files
authored
Merge pull request #3 from MShirazAhmad/copilot/revise-readme-installation-instructions
Add clear source installation and startup instructions to README and Read the Docs
2 parents 9435154 + 3a653da commit cca8e30

2 files changed

Lines changed: 78 additions & 6 deletions

File tree

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,52 @@
66

77
PhysPlot is a scientific plotting software with a graphical user interface, designed to produce publication-ready 2D plots. It supports vector and bitmap output, including PDF, Postscript, SVG and EPS. It allows data to be imported from text, CSV and Excel files and It can export data in text format. Datasets can also be entered within the program, and new datasets can be created via the manipulation of existing datasets using mathematical expressions.
88

9+
## Quick Start (from source)
10+
11+
Clone the repository:
12+
13+
```bash
14+
git clone https://github.com/MShirazAhmad/PhysPlot.git
15+
cd PhysPlot
16+
```
17+
18+
Create and activate a virtual environment:
19+
20+
```bash
21+
python -m venv .venv
22+
```
23+
24+
On macOS/Linux:
25+
26+
```bash
27+
source .venv/bin/activate
28+
```
29+
30+
On Windows (PowerShell):
31+
32+
```powershell
33+
.venv\Scripts\Activate.ps1
34+
```
35+
36+
Install dependencies:
37+
38+
```bash
39+
python -m pip install --upgrade pip
40+
python -m pip install -r requirements.txt
41+
```
42+
43+
Run PhysPlot:
44+
45+
```bash
46+
python PhysPlot.py
47+
```
48+
49+
Alternative module entry point:
50+
51+
```bash
52+
python -m physplot
53+
```
54+
955
## License, Tutorials, and Contributions
1056

1157
PhysPlot source code is licensed under the PolyForm Noncommercial License 1.0.0. You may fork PhysPlot, study the code, make noncommercial improvements, and submit revisions back through pull requests.

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)