Skip to content

Commit 9e1052d

Browse files
committed
docs: clarify recommended install workflow
1 parent 02f90d6 commit 9e1052d

1 file changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,24 @@ Continued support for PINGMapper and tools in the [PING Ecosystem](./docs/PINGEc
104104

105105
## Quick Start
106106

107-
### Option A: Conda
107+
Recommended workflow: install Miniforge, use PINGInstaller to set up the `ping` environment, and launch PINGWizard for testing, updates, and routine processing.
108+
109+
### Recommended: Miniforge + PINGInstaller + PINGWizard
110+
111+
Please see [Getting Started](https://cameronbodine.github.io/PINGMapper/docs/gettingstarted) for full instructions. In short:
112+
113+
```bash
114+
pip install pinginstaller -U
115+
python -m pinginstaller
116+
```
117+
118+
After installation completes, launch PINGWizard using the shortcut created by PINGInstaller, or run:
119+
120+
```bash
121+
conda run -n ping python -m pingwizard
122+
```
123+
124+
### Alternative: Direct conda environment
108125

109126
Please see [Getting Started](https://cameronbodine.github.io/PINGMapper/docs/gettingstarted) for full instructions, or simply run:
110127

@@ -114,9 +131,9 @@ conda activate ping
114131
python -m pingmapper gui
115132
```
116133

117-
### Option B: Pixi
134+
### Optional: Pixi
118135

119-
[Pixi](https://pixi.sh) manages all dependencies (including GDAL) automatically from a single `pyproject.toml`.
136+
[Pixi](https://pixi.sh) is available for users who prefer that workflow, but it is not the recommended installation path.
120137

121138
1. [Install pixi](https://pixi.sh)
122139
2. Clone and run:
@@ -132,7 +149,7 @@ python -m pingmapper gui
132149

133150
### Verify Installation
134151

135-
Run a lightweight self-check (same check used in CI):
152+
Recommended routine verification is to run the included tests from PINGWizard. If you want a prompt-based check, run the lightweight self-check below:
136153

137154
```bash
138155
python -m pingmapper check

0 commit comments

Comments
 (0)