-
Notifications
You must be signed in to change notification settings - Fork 5
docs: restructure into per-interface guides, refresh branding, fix stale content [PYSDK-144] #664
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
omid-aignostics
wants to merge
6
commits into
main
Choose a base branch
from
docs/PYSDK-144-restructure-guides-branding
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1a671bb
docs: restructure into per-interface guides, refresh branding, fix st…
omid-aignostics 23ae3ea
Merge branch 'main' into docs/PYSDK-144-restructure-guides-branding
omid-aignostics c0cd1a2
docs: use absolute Read the Docs URL for the Platform Overview link i…
omid-aignostics 4710f94
docs: fix run-state wording in Platform Overview [PYSDK-144]
omid-aignostics ce3d889
docs: use relative _static paths for Launchpad screenshots [PYSDK-144]
omid-aignostics 9bcb188
docs: align interface count and spelling in Platform Overview [PYSDK-…
omid-aignostics File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| ## Sign up for the Aignostics Platform | ||
|
|
||
| Before you can run an analysis, you need an account on the Aignostics Platform. These account steps are the same whichever interface you use. | ||
|
|
||
| > 💡 **Already have an account?** Skip to the installation steps below. | ||
|
|
||
| 1. **Find your invitation email.** Look in your inbox for a message from `support@aignostics.com`, with a subject like "You've been invited to join your organization's Aignostics account". If you can't find it, check your spam folder. If it isn't there either, ask your organization's administrator or email `support@aignostics.com`. | ||
|
|
||
| 2. **Accept the invitation.** Open the email and click **Accept Invitation**. A page opens in your browser where you enter your full name and set a password. | ||
|
|
||
| 3. **Set up two-factor authentication.** Next, you are asked to set up two-factor authentication. This is a second login step that uses a code from your phone. Install one of these free authenticator apps, then scan the code shown in your browser and enter the six-digit code it gives you: | ||
|
|
||
| - **Android:** [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) | ||
| - **iPhone:** [Google Authenticator](https://apps.apple.com/app/google-authenticator/id388497605) | ||
|
|
||
| You are done when you see "Welcome to the Console of the Aignostics Platform". From now on, each time you log in you enter your password and then a fresh six-digit code from the app. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| # Get started with the CLI | ||
|
|
||
| The **Aignostics CLI** is a command-line tool for interacting with the Aignostics Platform directly from your terminal or shell scripts. It is well suited to processing larger cohorts, automating repetitive analyses, and integrating with computational pipelines. | ||
|
|
||
| Common workflows: | ||
|
|
||
| - Download public datasets from the NCI Image Data Commons | ||
| - Submit batch processing runs for many slides | ||
| - Monitor run status and download results incrementally | ||
| - Automate repetitive tasks with shell scripts | ||
|
|
||
| ```{include} ../partials/_get_started_signup.md | ||
| ``` | ||
|
|
||
| ## Install the CLI | ||
|
|
||
| The CLI runs through [uv](https://docs.astral.sh/uv/). The command below installs uv if it isn't already present, updates it if it's out of date (including Homebrew-managed installs), and makes it available in your current shell. Afterwards every command is available through `uvx aignostics`. | ||
|
|
||
| **On macOS or Linux:** | ||
|
|
||
| ```bash | ||
| if ! command -v uv &> /dev/null; then | ||
| echo "uv not found, installing..." | ||
| curl -LsSf https://astral.sh/uv/install.sh | sh | ||
| source $HOME/.local/bin/env | ||
| else | ||
| UV_VERSION=$(uv --version | cut -d' ' -f2) | ||
| if [ "$(printf '%s\n' "0.6.17" "$UV_VERSION" | sort -V | head -n1)" != "0.6.17" ]; then | ||
|
omid-aignostics marked this conversation as resolved.
|
||
| echo "Updating uv to the latest version..." | ||
| UV_PATH=$(which uv) | ||
| if [[ "$UV_PATH" == *"brew"* ]]; then | ||
| echo "Updating uv using Homebrew..." | ||
| brew upgrade uv | ||
| else | ||
| echo "Updating uv using the installer..." | ||
| uv self update | ||
| fi | ||
| else | ||
| echo "uv is up to date" | ||
| fi | ||
| fi | ||
| ``` | ||
|
|
||
| **On Windows (PowerShell):** | ||
|
|
||
| ```powershell | ||
| winget install --id=Microsoft.VCRedist.2015+.x64 -e | ||
| powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" | ||
| ``` | ||
|
|
||
| Verify the install: | ||
|
|
||
| ```bash | ||
| uvx aignostics --help | ||
| ``` | ||
|
|
||
| You should see the list of available command groups (`application`, `dataset`, `bucket`, `system`, and more). If the command isn't found, open a new terminal and try again. | ||
|
|
||
| ## Run Atlas H&E-TME from the command line | ||
|
|
||
| This example downloads a public lung cancer dataset, submits an [Atlas H&E-TME](https://www.aignostics.com/products/he-tme-profiling-product) run, and downloads the results: | ||
|
|
||
| ```shell | ||
| # Download a sample dataset from the NCI Image Data Commons (IDC) portal. | ||
| # This dataset id refers to the TCGA LUAD collection and creates a tcga_luad directory of DICOM files. | ||
| uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 data/ | ||
| # Prepare a run.csv, extracting the required metadata from the DICOM files. | ||
| uvx aignostics application run prepare he-tme data/tcga_luad/run.csv data/ | ||
| # Edit the run.csv to add the required staining method, tissue type, and disease (use any editor). | ||
| nano data/tcga_luad/run.csv | ||
| # Upload the run.csv and referenced whole slide images to the Aignostics Platform. | ||
| uvx aignostics application run upload he-tme data/tcga_luad/run.csv | ||
| # Submit the application run and print the run id. | ||
| uvx aignostics application run submit he-tme data/tcga_luad/run.csv | ||
| # Check the status of your run. | ||
| uvx aignostics application run list | ||
| # Incrementally download results as they become available (use the id from the previous step). | ||
| uvx aignostics application run result download APPLICATION_RUN_ID | ||
| ``` | ||
|
|
||
| For convenience, `application run execute` combines preparation, upload, submission, and download. The command below is equivalent to the above, supplying the required metadata with a mapping: | ||
|
|
||
| ```shell | ||
| uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 data/ | ||
| uvx aignostics application run execute he-tme data/tcga_luad/run.csv data/ --mapping ".*\.dcm:staining_method=H&E,tissue=LUNG,disease=LUNG_CANCER" | ||
| ``` | ||
|
|
||
| The CLI provides extensive help at every level: | ||
|
|
||
| ```shell | ||
| uvx aignostics --help # list all command groups | ||
| uvx aignostics application --help # subcommands in the application group | ||
| uvx aignostics application run --help # subcommands in the application run group | ||
| uvx aignostics application run list --help # help for a specific command | ||
| ``` | ||
|
|
||
| See the [CLI reference](https://aignostics.readthedocs.io/en/latest/cli_reference.html) for all commands and options. | ||
|
|
||
| ## System health checks | ||
|
|
||
| The CLI checks system health before uploading slides or submitting runs. If the system is unhealthy, the operation is blocked: | ||
|
|
||
| ``` | ||
| Error: Platform is not healthy: <reason>. Aborting. | ||
| ``` | ||
|
|
||
| To override this (not recommended for production), add `--force`: | ||
|
|
||
| ```shell | ||
| uvx aignostics application run upload he-tme data/tcga_luad/run.csv --force | ||
| uvx aignostics application run submit he-tme data/tcga_luad/run.csv --force | ||
| uvx aignostics application run execute he-tme data/tcga_luad/run.csv data/ --force | ||
| ``` | ||
|
|
||
| To check system health manually: | ||
|
|
||
| ```shell | ||
| uvx aignostics system health | ||
| ``` | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.