{% extends layout|default('base.html', true) %} {% block style %} {% endblock %} {% block content %} Plexora - Settings {# The rail is rendered from settings_routes.SECTIONS and the panels are written by hand below, keyed by the same id. That split is deliberate: a section's NAME and ORDER are one line of Python, so adding one never means editing three places to keep a list in step, while its CONTENT is markup and belongs in a template rather than in a string in a route module. Panels are all present in the DOM and shown one at a time. With one section that is indistinguishable from rendering only the active one; with six it is what keeps switching tabs instant, and it is the arrangement the CSS and the JS below are written for. #}

Settings

Preferences for this copy of Plexora.

{% if website %} {# The website keeps projects in this site's storage in the browser or in workspace folders the user granted (services/ browserStore.js, on the host page): the default one, where new work is saved, and any others added here, each mounted for Python at /library/ (workers/pythonWorker.js). settingsPage.js's WebLocations draws the rows. #}

Where your projects are

Your figures, thresholds and gates. Your images stay where they are.

Loading…
{# Both icons from the start: Font Awesome swaps each span for an svg once, so the tone (data-tone) picks one in CSS. #}
Storage used in this browser
Loading…
{# Every pyramid the website made of the user's files, wherever it is kept (services/derivedIndex.js, on the host page), with what can be done to it. settingsPage.js fills it in. #} {# Saving gates, QC calls and ROI columns into the table or .h5ad the user opened (services/sourceWrites.js, on the host page; plexora/server/utils/source_writes.py). Off by default. #} {% else %} {# Every folder Plexora finds projects in (server/models/ library.py): the data directory, Documents/Plexora that the website shares, its older nested folder, workspaces added here and shared roots. Drawn by settingsPage.js's LocationsSection from /settings/locations, for the reason the data-directory card below is: one renderer, redrawn from each change's answer. Above that card because it is the wider question -- the data directory is one of these. #}

Locations

The folders Plexora lists projects from. New projects are saved in the default one; your images stay where they are.

Loading…
{# Both icons from the start: Font Awesome swaps each span for an svg once, so the tone (data-tone) picks one in CSS. #}
{# A folder somebody already has -- made by the website, by another computer, or copied from a colleague. Nothing in it is moved; only a missing workspace.json is written. #}

Data directory

Plexora's own folder, listed above as Data folder: its settings, its caches, and the projects and figures saved in it. Plexora reads this once when it starts, so a change takes effect the next time it is launched.

{# Filled by settingsPage.js from /settings/data. Rendered empty rather than server-side because the same markup has to be redrawn after a save, and one renderer beats a Jinja copy and a JS copy that drift. #}
Current location
Loading…
{# Shown only when the settings file and the running process disagree -- i.e. a change was saved and nothing has restarted yet. Both paths are named, because "pending" is meaningless without saying pending FROM what. #} {# An environment variable beats the settings file (see paths._candidate_data_root), so when one is set the form is not merely disabled -- the server refuses the write too. Two places, because a disabled control is a hint and the 409 is the rule. #}
{% if not data.notebook_mode %} {# Opens a picker on the SERVER's machine, which is why it is not offered in notebook/hosted mode -- /browse_path refuses it there for the same reason. #} {% endif %}

Existing projects stay where they are unless you choose to bring them along on the next step.

{# The review step. Nothing is written until the button in here is pressed, so this is the only place the consequences of the choice are stated -- what is already in the target, whether a move would be a rename or an hour of copying, and what would collide. #} {# Migration progress. Counted in projects rather than bytes -- see data_migration's module docstring for why a byte total would cost a full tree walk before anything visibly starts. #} {# Shared directories are rows of the Locations card above. #} {% endif %}
{# Remote servers. The same job `plexora connect` does, with the ssh command lines replaced by a saved profile and a button. There is no form here: adding a server means answering questions about somebody else's cluster, and those answers are properties of the SITE -- so the page offers the sites instead, and the questions that genuinely differ are asked on the preset's own form. See settingsPage.js's drawCatalogue for what used to be here. #}

Remote servers

{% if website %} {# The website signs in to a server in this page, through the relay, and starts a data node there; the node's files then open here (services/webRemote.js, docs/internal/ WEB_REMOTE_RELAY.md). Nothing is installed on this computer. #}

Plexora signs in to a server from this page and starts a data node there. Its files then open here, under Remote in every file picker. Nothing is installed on this computer.

{% else %} {# The one sentence this panel needs before either box: which machine Plexora is, and which machines these are. Running Plexora ITSELF somewhere else is a launch decision made on that machine, not a setting inside a running Plexora, and the panel says so rather than leaving somebody to look for the field that would do it. #}

Plexora runs on one machine and reaches every other one over SSH.

{# The other half of that sentence, and the half people come here looking for. The note above says the panel tells them where the launch decision is made; saying it takes the command, because "start it there" with no example is not an instruction anybody can act on. #}

To run Plexora itself on one of them, start it there rather than from here — plexora connect you@login.cluster.edu in a terminal, or Open OnDemand, or a Jupyter session. From that Plexora the cluster is Local, and these same saved servers are what plexora connect reads.

{% endif %} {# Two things, boxed apart. What you have saved and what you can add were a run of cards and a heading on one flat background, so the presets read as more saved servers with the wrong buttons on them. The saved half gets a container with its own title; the catalogue below stays on the page's own ground, which is the whole of the distinction. #}

Saved connections

Save a remote connection once, then reconnect by name.

Loading…
{# The catalogue, drawn by settingsPage.js from the same cards the connection dialog uses. Empty in the markup on purpose: this list is a static description of other people's clusters and is fetched once, by whichever surface asks first, rather than being rendered into every page that has a Settings link. What stood here was a hand-written form of twelve boxes and a "Use preset..." button beside it. Seven of those boxes asked what a preset asks, with a second set of defaults to keep in step; the three that were genuinely its own -- the data directory, extra port forwarding, and forwarding from the login node -- moved into the preset form's Advanced section, which is where the rest of that question already lived. Two grids, not one: the five kinds of machine anyone can have, and then the named institutions behind "Additional presets". See connectionModal.js's recipeGrid. #}

Add a New Connection

Start from the kind of machine you use. Plexora fills in what it knows; you can change any of it afterwards. If your institution's cluster is one Plexora already knows, it is under Additional presets.

Loading…
{# Data nodes: what is CURRENTLY reachable, which is a different question from which servers are saved next door. Most entries here now appear and disappear on their own -- a data field's Remote option opens one, `plexora connect` opens one on the user's laptop -- so this section reads as a status board first and an address book second. The manual form stays because a node somebody started by hand is still a thing that exists, but it is behind a disclosure: it is now the exception. #}

Data nodes

{% if website %} {# The website reaches a server's files through a node started there and paired with this browser (services/connectorClient.js): the link it prints pairs it in one click. #}

Data on a server, read where it is. Start a node there and pair it with this browser.

{% else %}

Machines that are handing this Plexora data right now. Most of them arrive by themselves: choosing Remote on a data field opens one on a saved server, and plexora connect opens one on your own computer. Nothing here needs setting up before you import.

Which files a project reads from a node is chosen on that project’s own page. This is only the address book.

{% endif %}
Loading…
Add a node by hand

For a node you started yourself with plexora node serve on a machine this one can already reach. A node opened from a data field or by plexora connect registers itself.

{% if not website %} {% endif %}
{# Web data: the on-disk chunk cache behind an image opened from https / s3 / gs / az, and the address book of per-bucket options a private one needs. See server/models/remote_sources.py and server/utils/remote_store.py -- this panel is the whole of what those two keep, drawn by settingsPage.js's WebDataSection from `GET /settings/webdata`. #}

Web data

An image opened straight from a web address is read through a cache on this disk, one chunk at a time, so the same bytes are not fetched twice. This is where that cache is, how big it may get, and what is in it right now.

Cache location
Loading…

Kept inside the data directory. Moving the data directory in the Data section above takes this cache with it, and clearing it never touches the images themselves, only this copy of their bytes.

Budget
GB
{# The used/budget meter. Two fills over one track rather than a stacked bar -- see settings.css -- because what is kept offline is a SUBSET of what is cached, not a second quantity beside it. #}

Stores

Loading…
{# The address book: options.py per URL prefix, for a bucket that needs an endpoint, an anonymous read or a named profile. The import dialog can add an entry here too, from the moment a bucket is first picked -- this is the same list, read back. #}

Address book

Options for private buckets or S3-compatible servers, saved once per web address prefix. Keys are never stored here — Plexora uses your AWS/Google/Azure credentials from the environment.

Loading…
Add an entry
{# Updates: the same answers as Help > Check for Updates, and the two preferences it keeps (update_routes.py, `updates` in the settings file). The dialog does the updating; this panel only says what is installed and sets whether to look. #}

Updates

{% if website %}

The website is always the current version of Plexora: there is nothing to install or restart.

Version
Plexora {{ version }}
{% else %}

Plexora looks for a newer release once a day and puts a dot on the Help menu when there is one. It never installs anything until you ask.

Installed version
Loading…
{% endif %}
{# Usage data: the telemetry mode (plexora/telemetry, `telemetry` in the settings file) and a look at exactly what would be sent. The radios are disabled, with the reason, when an environment variable or the service decides instead. #}

Usage data

Plexora can send anonymous usage counts — which features are used, how long tiles take to draw, which kinds of errors occur — so we know what to improve. It never sends file names, project names, marker or gene names, cell data, coordinates, usernames, machine names or anything typed into a tool. Everything is queued on this machine first, and nothing in Plexora waits for it or depends on it.

What to send

Also off with plexora telemetry off or DO_NOT_TRACK=1.

This installation
—
{# Account (the section id stays `license`, which links name): who this device is signed in as, the plan (plexora/licensing) from /license/status, the organisation's AI credits, and the three ways to add Pro -- connect this device (a code the person approves at account.biocognia.com), the licence key shown under Licences in the portal (or an activation code or token), or an offline licence file -- behind one switch, so the page shows one form at a time. On Free nothing here asks the BioCognia platform anything until a button does. On a connected device the account and the credits are asked for when the page opens, and held in the page only: the email is never stored. Plexora never sees a password: signing in happens in the browser. #}

Account

Plexora AI is currently invite only. If you would like to be considered, email support@biocognia.com.

{# Who you are: GET /settings/license/account, drawn by settingsPage.js AccountView. `data-state` is none, loading, shown or unavailable; the note says why when there is no one to show. #} {# The plan. `data-tone` (settingsPage.js LicenseSection.draw) colours the seal and the status: pro, warn, lapsed or free. #}
Your plan Free
{# On the website the browser holds the licence (services/licenseClient.js): forgetting it releases the device on the seat, then clears it. #} {% if website %} {% else %} {% endif %}
{# Where Pro is bought, on a page without it: the pricing section of biocognia.com, then checkout at account.biocognia.com. The key the seat comes with goes in Licence key below. A line in the card, not a banner: it never moves, opens or nags. #}
{# The organisation's Plexora AI credits, on a licence with AI: GET /ai/v1/balance, asked again when the window comes back (credits bought in the browser meanwhile). #}

Add a licence

{% if not website %} {% endif %}
{# Connect this device: the device flow. The page asks for a short code, shows it with the link, opens the link, and polls until the person approves it in the browser. #}

{% if website %} Approve the code at account.biocognia.com and your licence appears here, kept in this browser. {% else %} Sign in at account.biocognia.com and approve this device. Plexora shows a short code and opens the page; when you approve it, your licence appears here. Connecting this computer also connects your other BioCognia tools on it. {% endif %}

{% if website %} {% else %} {% endif %}
{% if not website %} {% endif %}

Your data never leaves this machine: a licence check sends the certificate and a hash that identifies this device, nothing else. Your email and name are read from account.biocognia.com each time this page opens, and are never saved on this computer.

{# Advanced, the desktop app's own (settings_routes.DESKTOP_SECTIONS): "Browser rendering" (plexora/browser_rendering.py). Off until the website's GA; with it on, the window reads a project's image and mask itself, through the app's own file scheme. #} {% if desktop %}

Advanced

How this window reads your images.

Browser rendering

Applies to projects opened after the change.

{% endif %}
{# remoteState.js is loaded by base.html, above and deferred, so it is parsed before this file runs -- the Remote servers section is one of its subscribers rather than a poller of its own. #} {% endblock %}