Before you begin¶
Getting an account¶
- Logging in with GitHub
- Logging in with ORCID
- Logging in by email magic link
- Being added to your group's instance by an administrator
- Account states: what "unverified" or "deactivated" means and who can fix it
Which methods are available depends on the instance
Your administrator chooses which login providers are enabled. If the button you expect is missing from the login menu, ask them rather than creating a second account.
Finding out what your instance can do¶
Before following the rest of this guide, it is worth checking:
- Which item types exist. Samples, cells, starting materials and equipment are built in; your instance may have more.
- Which data blocks are installed. These determine which file formats can be plotted in-app.
- Whether the inventory is editable by ordinary users, or admin-only.
- What your instance's identifier prefix is. It is the first part of every refcode.
assets/screenshots/deployment-info.png — the deployment info / about panel showing the
instance name, version and identifier prefix.
Conventions used in this guide¶
| Convention | Meaning |
|---|---|
grey_ab123 |
A refcode. Yours will start with your instance's own prefix. |
| Admin only | The action needs elevated permissions. |
| Experimental | The feature may change; see What's next. |