Skip to main content

Software download and system setup

Use this section to install CytoCanvas and ensure your system meets performance requirements.

Install CytoCanvas

To install CytoCanvas™, visit the Download CytoCanvas website and follow the onscreen prompts.

Compatibility

CytoCanvas is compatible with the following operating systems (OS):

  • Windows OS
  • MacOS on Intel or M chips
  • (Limited support) Linux OS on a Debian distribution with AMD64 architecture, recommended minimum Ubuntu 20.04 LTS

System performance recommendations

CytoCanvas is a performance-intensive application. If the application is running slowly, complete the following recommendations to improve software performance:

  • Use a computer with a minimum of 32GB RAM and a graphics processing unit (GPU).
  • View a limited number of layers of data at the same time.
  • Close any other GPU-intensive or CPU-intensive applications.
  • Load the data from a local source, instead of a cloud location.

Manage AWS credential profiles

CytoCanvas stores AWS credentials as named profiles so that you can reuse them across sessions without re-entering keys each time. Profiles are managed centrally and are not embedded in individual workspaces.

Add a credential profile

  1. Open the CytoCanvas application.
  2. Select Manage Credentials.
  3. Select Add Profile.
  4. Enter a profile name and the following AWS credential information:
    • AWS Access Key ID
    • AWS Secret Key
    • (Optional) AWS Session Token, if you use temporary credentials
    • AWS Region
  5. Select Save.

    The profile is now available to select when loading data from Amazon S3.

Import profiles from the AWS CLI

If you have the AWS CLI installed and already configured credential profiles on your system, CytoCanvas can read them directly without re-entering your keys. AWS CLI profiles are stored in ~/.aws/credentials and ~/.aws/config on your local machine.

  1. Open the CytoCanvas application.
  2. Select Manage Credentials.
  3. Select Import from AWS CLI.

    CytoCanvas reads your local AWS credential files and lists the available named profiles.

  4. Select the profile you want to import and select Import.

    The imported profile is now available to select when loading data from Amazon S3.

For information about the AWS CLI credential file format and how to create or manage named profiles, see the AWS CLI configuration and credential file settings documentation.

Edit or delete a credential profile

  1. Open the CytoCanvas application.
  2. Select Manage Credentials.
  3. Select the profile that you want to edit or delete.
    • To edit, update the credential fields and select Save.
    • To delete, select Delete Profile and confirm.