Skip to content

Commit 18a6c19

Browse files
docs: add quick start to public documentation [skip:ci, skip:test:long-running, skip:test:matrix-runner, skip:test:very-long-running]
1 parent 6b8656f commit 18a6c19

File tree

3 files changed

+165
-62
lines changed

3 files changed

+165
-62
lines changed

CLI_REFERENCE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $ aignostics [OPTIONS] COMMAND [ARGS]...
1414
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
1515
* `--help`: Show this message and exit.
1616

17-
🔬 Aignostics Python SDK v0.2.211 - built with love in Berlin 🐻
17+
🔬 Aignostics Python SDK v0.2.212 - built with love in Berlin 🐻
1818

1919
**Commands**:
2020

@@ -207,7 +207,7 @@ $ aignostics application run execute [OPTIONS] APPLICATION_ID METADATA_CSV_FILE
207207
* `--application-version TEXT`: Version of the application. If not provided, the latest version will be used.
208208
* `--create-subdirectory-for-run / --no-create-subdirectory-for-run`: Create a subdirectory for the results of the run in the destination directory [default: create-subdirectory-for-run]
209209
* `--create-subdirectory-per-item / --no-create-subdirectory-per-item`: Create a subdirectory per item in the destination directory [default: create-subdirectory-per-item]
210-
* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds. [default: 1764159121212.228]
210+
* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds. [default: 1764259829333.159]
211211
* `--wait-for-completion / --no-wait-for-completion`: Wait for run completion and download results incrementally [default: wait-for-completion]
212212
* `--note TEXT`: Optional note to include with the run submission via custom metadata.
213213
* `--due-date TEXT`: Optional soft due date to include with the run submission, ISO8601 format. The scheduler will try to complete the run by this date, taking the subscription tierand available GPU resources into account.
@@ -275,7 +275,7 @@ $ aignostics application run upload [OPTIONS] APPLICATION_ID METADATA_CSV_FILE
275275
**Options**:
276276

277277
* `--application-version TEXT`: Version of the application. If not provided, the latest version will be used.
278-
* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds. [default: 1764159121212.4172]
278+
* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds. [default: 1764259829333.3188]
279279
* `--onboard-to-aignostics-portal / --no-onboard-to-aignostics-portal`: If set, the run will be onboarded to the Aignostics Portal. [default: no-onboard-to-aignostics-portal]
280280
* `--help`: Show this message and exit.
281281

README.md

Lines changed: 81 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,57 @@ more about how we achieve
4444
[operational excellence](https://aignostics.readthedocs.io/en/latest/operational_excellence.html) and
4545
[security](https://aignostics.readthedocs.io/en/latest/security.html).
4646

47+
## Installation
48+
49+
The **Aignostics Python SDK** can be installed via the [uv package manager](https://docs.astral.sh/uv/). The installation process sets up the SDK along with the necessary dependencies, including the **uv** package manager itself if not already present.
50+
51+
Before proceeding, ensure you have an **Aignostics Platform account**. You can get access either through your organization admin (if your organization has an Aignostics account) or directly from Aignostics. Check your email for an invitation before proceeding.
52+
53+
The installation will:
54+
1. Install or update **uv** (Python package installer)
55+
2. Install the **Aignostics Python SDK** (includes Launchpad, CLI, and Python Library)
56+
57+
Copy and paste the appropriate command below into your terminal (macOS/Linux) or PowerShell (Windows):
58+
59+
60+
**Linux/macOS:**
61+
```bash
62+
if ! command -v uv &> /dev/null; then
63+
echo "uv not found, installing..."
64+
curl -LsSf https://astral.sh/uv/install.sh | sh
65+
source $HOME/.local/bin/env
66+
else
67+
UV_VERSION=$(uv --version | cut -d' ' -f2)
68+
if [ "$(printf '%s\n' "0.6.17" "$UV_VERSION" | sort -V | head -n1)" != "0.6.17" ]; then
69+
echo "Updating uv to the latest version..."
70+
UV_PATH=$(which uv)
71+
if [[ "$UV_PATH" == *"brew"* ]]; then
72+
echo "Updating uv using Homebrew..."
73+
brew upgrade uv
74+
else
75+
echo "Updating uv using the installer..."
76+
uv self update
77+
fi
78+
else
79+
echo "uv is up to date"
80+
fi
81+
fi
82+
```
83+
84+
**Windows (PowerShell):**
85+
```powershell
86+
winget install --id=Microsoft.VCRedist.2015+.x64 -e
87+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
88+
```
89+
90+
Verify your installation by running:
91+
```bash
92+
uvx aignostics --help
93+
```
94+
You should see the Aignostics CLI help output.
95+
96+
You can then proceed by choosing your preferred user interface below.
97+
4798
## Choose your interface
4899

49100
Choose your preferred interface for working with the Aignostics Platform. Each interface is designed for different user roles and use cases:
@@ -84,19 +135,18 @@ Choose your preferred interface for working with the Aignostics Platform. Each i
84135

85136
The **Aignostics Launchpad** is a graphical desktop application that allows you to run applications on whole slide images (WSIs) from your computer, and inspect results with QuPath and Python Notebooks with one click. It is designed to be user-friendly and intuitive, for use by Research Pathologists and Data Scientists.
86137

87-
### Installation
88-
89-
The Launchpad is available for Mac OS X, Windows, and Linux, and can be installed easily:
90-
91-
1. Visit the [Quick Start](https://platform.aignostics.com/getting-started/quick-start) page in the Aignostics Console.
92-
2. Copy the installation script and paste it into your terminal - compatible with MacOS, Windows, and Linux.
93-
3. Launch the application by running `uvx aignostics launchpad`. The system displays the Launchpad welcome screen showing available applications and existing application runs in the left sidebar.
138+
**New to Launchpad?** See <a href="#installation">Installation</a> section above to get started.
94139

95140
### Running Your First Analysis
96141

97142
This tutorial uses [Atlas H&E-TME](https://www.aignostics.com/products/he-tme-profiling-product) with a public lung cancer dataset from the NCI Image Data Commons.
98143

99-
**Step 1: Download a Sample Dataset**
144+
**Step 1: Start Aignostics Launchpad**
145+
1. Open a terminal or command prompt
146+
2. Run the command: `uvx aignostics launchpad`
147+
This starts the Launchpad application.
148+
149+
**Step 2: Download a Sample Dataset**
100150

101151
1. Click the menu icon (☰) in the top right corner
102152
2. Click "Download Datasets". The system displays the dataset download interface.
@@ -106,14 +156,14 @@ This tutorial uses [Atlas H&E-TME](https://www.aignostics.com/products/he-tme-pr
106156
6. Click "DOWNLOAD". The system downloads the DICOM dataset. A progress indicator shows download status.
107157
7. Click the menu icon and select "Run Applications"
108158

109-
**Step 2: Select Atlas H&E-TME**
159+
**Step 3: Select Atlas H&E-TME**
110160

111161
1. Click "Atlas H&E-TME" in the left sidebar. The system displays the application workflow with six steps.
112162
2. Click the version dropdown to view available versions. The system shows all available versions with release notes accessible via the "RELEASE NOTES" button.
113163
3. Keep the default version (latest)
114164
4. Click "NEXT"
115165

116-
**Step 3: Select Slides and Provide Metadata**
166+
**Step 4: Select Slides and Provide Metadata**
117167

118168
1. Click "DATA". The system opens a folder selection dialog showing the Launchpad datasets directory.
119169
2. Navigate to the downloaded dataset folder (e.g., `/datasets/idc/tcga_luad/`)
@@ -123,29 +173,29 @@ This tutorial uses [Atlas H&E-TME](https://www.aignostics.com/products/he-tme-pr
123173
6. Review the "Staining" column. The system shows "H&E" if this information was extracted from the DICOM file.
124174
7. Click "NEXT"
125175

126-
**Step 4: Add Notes and Tags (Optional)**
176+
**Step 5: Add Notes and Tags (Optional)**
127177

128178
1. The system displays the notes and tags screen.
129179
2. Enter an optional note in the text field (e.g., "TCGA lung sample analysis")
130180
3. Add optional tags by typing and pressing Enter (e.g., "TCGA", "lung")
131181
4. Click "NEXT"
132182

133-
**Step 5: Set Schedule (Optional)**
183+
**Step 6: Set Schedule (Optional)**
134184

135185
1. The system displays scheduling options with soft due date and hard deadline pickers.
136186
2. Click "NEXT" to leave the default settings.
137187

138188
The soft due date indicates when the platform will attempt to complete processing. The hard deadline is when the platform may cancel the run if resources are unavailable.
139189

140-
**Step 6: Submit Your Run**
190+
**Step 7: Submit Your Run**
141191

142192
1. The system displays the submission screen showing number of slides to be analyzed, full file paths, and upload and submit button.
143193
2. Review the slide information
144194
3. Click "UPLOAD AND SUBMIT". The system uploads your slides to the Aignostics Platform and submits the analysis run. A progress indicator shows upload status.
145195

146196
The left sidebar now shows your submitted run with application name and version, submission timestamp, running status icon (🏃), and any tags you added.
147197

148-
**Step 7: Monitor Your Run**
198+
**Step 8: Monitor Your Run**
149199

150200
Atlas H&E-TME processing time depends on slide size and system load. Depending on the file size and the number of files, processing can take minutes to many hours.
151201

@@ -194,6 +244,8 @@ QuPath integration provides the most powerful way to visualize and interact with
194244
The Python SDK includes the **Aignostics CLI**, a Command-Line Interface (CLI) that allows you to
195245
interact with the Aignostics Platform directly from your terminal or shell script.
196246

247+
**New to CLI?** See <a href="#installation">Installation</a> section above to get started.
248+
197249
**Common workflows:**
198250
- Download public datasets from NCI Image Data Commons
199251
- Submit batch processing runs for multiple slides
@@ -203,6 +255,10 @@ interact with the Aignostics Platform directly from your terminal or shell scrip
203255
See as follows for a simple example where we download a sample dataset for the [Atlas
204256
H&E-TME application](https://www.aignostics.com/products/he-tme-profiling-product), submit an application run, and download the results.
205257

258+
### Example: Running Atlas H&E-TME with CLI
259+
1. Open a terminal or command prompt
260+
2. Use the following commands to run the Atlas H&E-TME application on a sample dataset:
261+
206262
```shell
207263
# Download a sample dataset from the NCI Image Data Commons (IDC) portal to your current working directory
208264
# As the dataset id refers to the TCGA LUAD collection, this creates a directory tcga_luad with the DICOM files
@@ -250,32 +306,28 @@ to learn about all commands and options available.
250306

251307
## Python Library: Call the Aignostics Platform API from your Python scripts
252308

253-
> ⚠️ Before you get started, you need to set up your authentication credentials if
254-
> you did not yet do so! Please visit
255-
> [your personal dashboard on the Aignostics Platform website](https://platform.aignostics.com/getting-started/quick-start)
256-
> and follow the steps outlined in the `Enterprise Integration` section.
309+
The Python SDK includes the *Aignostics Python Library* for integration with your Python codebase.
257310

258-
Next to using the Launchpad, CLI and example notebooks, the Python SDK includes the
259-
*Aignostics Python Library* for integration with your Python Codebase.
311+
**New to Python Library?** See <a href="#installation">Installation</a> section above to get started.
260312

261-
The following sections outline how to install the Python SDK and interact with the library.
262313

263-
### Installation
314+
<!-- - **Authentication setup** - ADD INSTRUCTIONS. -->
264315

265-
The Aignostics Python SDK is required for using the CLI, Python Notebooks, and Python Library.
266-
It is published on the [Python Package Index (PyPI)](https://pypi.org/project/aignostics/),
267-
is compatible with Python 3.11 and above, and can be installed via `uv` or `pip`:
316+
### Installation
268317

269-
**Install with [uv](https://docs.astral.sh/uv/):** If you don't have uv
270-
installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/).
318+
Add the Aignostics Python SDK to your Python project:
271319

320+
**Install with [uv](https://docs.astral.sh/uv/):**
272321
```shell
273-
# Add Aignostics Python SDK as dependency to your project
274322
uv add aignostics
275323
```
276324

277-
**Install with [pip](https://pip.pypa.io/en/stable/)**
325+
**Install with [pip](https://pip.pypa.io/en/stable/):**
326+
```shell
327+
pip install aignostics
328+
```
278329

330+
**Install with [pip](https://pip.pypa.io/en/stable/):**
279331
```shell
280332
# Add Python SDK as dependency to your project
281333
pip install aignostics
@@ -410,7 +462,6 @@ Now that you have an overview of the Aignostics Python SDK and its interfaces, h
410462
- **Get support**: Contact [support@aignostics.com](mailto:support@aignostics.com) or check the [full documentation](https://aignostics.readthedocs.io/en/latest/)
411463

412464

413-
414465
## Platform
415466

416467
### Overview

0 commit comments

Comments
 (0)