Open Source

SDV Installer Reference

This page provides a reference for all the capabilities of the SDV Installer.

👉 For a step-by-step installation guide, please see the main Installation Instructions page instead.

Check Requirements

Use this command to verify whether the current environment meets the Technical Requirements needed to install SDV Enterprise.

sdv-installer check-requirements

Flags: (None)

List-Packages

Use the list-packages command list all the packages that you have access to.

sdv-installer list-packages

You will be prompted for some input.

  • When prompted for a username, enter your email

  • When prompted for a license key, enter your license key. Please be sure you copy-paste exactly as provided by DataCebo.

If this authenticates successfully, the installer will list all the packages you have access to — SDV Enterprise, as well as any additional bundles you have purchased. But it will not download or install any of them.

Username: <email>
License Key: ********************************

SDV Enterprise:
sdv-enterprise

SDV Bundles:
bundle-cag
bundle-xsynthesizers

Flags: (None)

Install

This is the basic install command that you can use to install packages from our server (or from local folder that already contains the packages).

sdv-installer install

When installing from our server, you will be prompted for some input.

  • When prompted for a username, enter your email

  • When prompted for a license key, enter your license key. Please be sure you copy-paste exactly as provided by DataCebo.

If this authenticates successfully, the installer will automatically install all the packages you have access to — SDV Enterprise, as well as any additional bundles you have purchased.

Username: <email>
License Key: ********************************

Installing SDV Enterprise:
sdv-enterprise (version 0.30.0) - Installed!

Installing Bundles:
bundle-cag - Installed!
bundle-xsynthesizers - Installed!

Success! All packages have been installed. You are ready to use SDV Enterprise.

Flags:

  • --upgrade: If you've already installed any of the SDV Enterprise packages, this flag will install the updated version (if one exists). If you haven't yet installed SDV Enterprise, it will install the most recent version.

  • --folder <folder_name>: If you provide the name of a folder, SDV Installer assumes you have already downloaded the packages that you need into the local folder. It will install those packages offline instead of accessing them from our server. (In this case, SDV Installer will not ask for username/license key credentials and will not require any connection to the internet.)

  • --package <package_name>: If you provide the name of a package, SDV Installer will only install the specific package (as opposed to all of them). Note that you must have permissions to access that particular package; use list-packages to see the names.

  • --options <optional_dependencies>: For some packages , you may want to pass in optional dependencies for your particular usage. List the dependencies using this flag. (This flag should be used in conjunction with the --package flag.)

  • --debug: When this flag is set, SDV Installer will print out all the commands it is running internally (with pip) as well as their outputs. This is useful when debugging the SDV Installer.

Download

Use the download command to download the packages from our server and save them locally in a folder. This command will not actually install those packages. This is useful if you want to complete the installation offline at a later point or on a different machine. (See the instructions for Download & Install Offline).

sdv-installer download --folder sdv-enterprise/

You will be prompted for some input.

  • When prompted for a username, enter your email

  • When prompted for a license key, enter your license key. Please be sure you copy-paste exactly as provided by DataCebo.

If this authenticates successfully, the installer will automatically download all the packages you have access to — SDV Enterprise, as well as any additional bundles you have purchased.

Username: <email>
License Key: ********************************

Downloading alling SDV Enterprise:
sdv-enterprise (version 0.30.0) - Downloaded!

Downloading Bundles:
bundle-cag - Downloaded!
bundle-xsynthesizers - Downloaded!

Success! All packages have been downloaded. Please install the packages to use SDV Enterp

Flags:

  • (required) --folder <folder_name>: Download the packages locally into the provided folder name. By default, the packages will be downloaded for your current environment.

  • --python-version <version_num>: Use this when you want to download packages for a different version of Python than the one you currently have.

    • Note that the version number you provide should not have decimal point or the patch version. For example, if you want Python version 3.11.13, provide 311.

    • Make sure the Python version is supported by SDV Enterprise. For more details, see Technical Requirements.

  • --platform <platform_name>: Use this when you want to download packages for a different OS platform than the one you are currently on. Support platform names include:

    • musllinux_1_1_x86_64 (Linux)

    • win_amd64 (Windows)

    • macosx_14_0_arm64 (Macs with M1/M2 chips)

    • macosx_10_9_x86_64 (older Macs with the Intel chips).

    Make sure the OS platform is supported by SDV Enterprise. For more details, see Technical Requirements.

To get the platform string of a machine, log into it and run the following commands in Python:

import sysconfig

platform = sysconfig.get_platform()
platform = platform.replace('-', '_').replace('.', '_')
print(platform)

MacOS users may need to provide multiple --platform flags. Use the code below to print out all tags that MacOS is compatible with.

from packaging import tags

supported_tags = []
for tag in tags.sys_tags():
    if tag.platform not in supported_tags:
        supported_tags.append(tag.platform)

print(supported_tags)

  • --package <package_name>: If you provide the name of a package, SDV Installer will only download the specific package (as opposed to all of them). Note that you must have permissions to access that particular package; use list-packages to see the names.

  • --options <optional_dependencies>: For some packages , you may want to pass in optional dependencies for your particular usage. List the dependencies using this flag. (This flag should be used in conjunction with the --package flag.)

  • --debug: When this flag is set, SDV Installer will print out all the commands it is running internally (with pip) as well as their outputs. This is useful when debugging the SDV Installer.

Uninstall

Use this command to uninstall all the SDV-related packages that you had previously installed in your environment.

sdv-installer uninstall

Flags: (None)

PreviousDownload & Install OfflineNextTroubleshooting

Last updated