Skip to main content

Version Migration Guide

Why Migrate?​

We recommend always using the latest version of Covalent in order to get the latest improvements to the UI, use the latest features, and to take advantage of improvements in workflow execution speed.

Migrating to the Current Version​

If you are using Covalent v0.110.2 or later you can upgrade to Covalent v0.177.0 or later as follows:

  1. Identify the currently installed version.
$ pip show covalent | grep Version
Version: 0.110.2
  1. Stop the server.
$ covalent stop
Covalent server has stopped.
  1. Install the new version of Covalent using Pip.
$ pip install covalent==0.202.0 --upgrade
$ pip show covalent | grep Version
Version: 0.202.0
  1. Migrate the database.
$ covalent db migrate
INFO  [alembic.runtime.migration] Context impl SQLiteImpl.
INFO  [alembic.runtime.migration] Will assume non-transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade  -> b60c5ecdf927, init
INFO  [alembic.runtime.migration] Running upgrade b60c5ecdf927 -> 9b9d58f02985, v11
Migrations are up to date.
  1. Start the server.
$ covalent start
Covalent server has started at http://localhost:48008
  1. Use the data migration tool to migrate any workflows you want to port to the new version of Covalent.

For example, for a workflow with dispatch ID e0ba03a2-fdc0-474e-9997-7fa8e82932c5:

$ covalent migrate-legacy-result-object /docs/get-started/results/e0ba03a2-fdc0-474e-9997-7fa8e82932c5/result.pkl
Processing result object for dispatch e0ba03a2-fdc0-474e-9997-7fa8e82932c5
Processing node 0
Processing node 1
Processing node 2
Processing node 3
Processed transport graph
Processed lattice
  1. Navigate to the UI http://localhost:48008 to view your workflows.