Conda Quickstart: Using SyncroSim with Conda
SyncroSim allows you to use conda environments to manage all of the software dependencies associated with a SyncroSim Package. You can also use conda environments with custom Packages (see the Adding Conda Environments tutorial). For additional information on using conda environments with SyncroSim, visit our Using Conda resource page.
Note
Conda support is available only in SyncroSim version 2.4 and higher
Installing a SyncroSim Package with conda support
If you attempt to install a SyncroSim Package that supports conda, and SyncroSim detects that you have not yet installed conda or created the conda environments required by the Package, you can follow these steps to install the Package and activate conda support.
- From File, select Packages… to open the Packages window.
- Click Install… in the bottom-left corner or Install from File… in the top-right corner to install your SyncroSim Package.
- Once you select the Package you wish to install, SyncroSim should display the following pop-up window:
- If you select Install Package(s) and Miniconda, then Miniconda will be installed into a folder within your SyncroSim installation. If you select Install Package(s) only, the Package will still be installed, but you will not be able to activate conda environments until you install Miniconda. Selecting Cancel will result in cancellation of the Package installation altogether.
- If you selected Install Package(s) and Miniconda in the previous step, once the Miniconda Installer finishes, the following pop-up will be displayed in the SyncroSim User Interface:
- If you select Yes, then the conda environment(s) required to run the Package will be created. Note that this will take a few minutes. If you select No, the Package will still be installed, but you will not be able to activate conda until you create the necessary conda environments. Selecting Cancel will result in cancellation of the Package installation altogether.
- Once you have installed Miniconda and created the conda environments for a Package, SyncroSim will not ask you to go through these set ups steps again.
Adding conda support to an installed Package
If the Package is already installed, follow these steps to turn conda environments on in the User Interface:
- Open or create a new Library for the Package that uses conda environments.
- Right-click on the Library and select Properties from the dropdown menu.
- Navigate to the Options tab in the Properties window.
- Within the Options window, enable the Use Conda checkbox.
- If you have not previously installed Miniconda or created the necessary conda environments for the given SyncroSim Package (e.g. during installation of the SyncroSim package), then you will be prompted to do so now.
Using a custom conda installation
If you have a conda installation that you would like to use with SyncroSim rather than installing Miniconda in the default location, you can use the following steps:
- When installing a SyncroSim Package that uses conda environments, select No when prompted to install Miniconda. The Package will still be installed and useable without conda environments.
- From File, select Settings… to open the Settings window.
- Under Conda installation folder, change the text to the proper system location or select Browse… to browse through your system files for the conda installation folder.
- Once you have set the custom conda installation folder, when you enable Use Conda from Library Properties > Options, you will be prompted to create the necessary conda environments for the given SyncroSim Package.
- Select Yes to create the new environment(s) within your custom environment. If you select No or Cancel, then Use Conda will remain disabled.