From 40acb331f7da9f6499548911f7df81794bf0f7fd Mon Sep 17 00:00:00 2001 From: Will Cunningham Date: Wed, 4 Jan 2023 10:15:35 -0500 Subject: [PATCH] updating compatibility matrix for 202 (#1371) * updating compatibility matrix for 202 * small fix * adding centos 7 python 3.9 * Update version migration doc The instructions on this page should be accurate assuming you can migrate from any version 0.110.2 or newer to any version 0.117.0 or newer. If that's not the case, we need to modify the page to account for differences in the migration process and/or disallowed combinations of versions. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * updating fedora version Co-authored-by: dwelsch-esi <116022979+dwelsch-esi@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- CHANGELOG.md | 4 + doc/source/getting_started/compatibility.rst | 159 +++++++++++++++++++ doc/source/version_migrations/index.rst | 89 ++++++----- 3 files changed, 215 insertions(+), 37 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c459cb79..8b6a293a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [UNRELEASED] +### Docs + +- Updated compatibility matrix + ## [0.209.1-rc.0] - 2022-12-15 ### Authors diff --git a/doc/source/getting_started/compatibility.rst b/doc/source/getting_started/compatibility.rst index c08e66592..bb098ed34 100644 --- a/doc/source/getting_started/compatibility.rst +++ b/doc/source/getting_started/compatibility.rst @@ -4,6 +4,164 @@ Compatibility Covalent is primarily developed using Python 3.8 on MacOS and Linux. It has been tested in a variety of environments. The following tables list combinations of Python versions and operating systems that have been tested with release versions of Covalent. +v0.202.0 +******** + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OS VersionPython VersionSupportedNotes
macOS 11 (Big Sur)3.8STABLEOfficially supported.
3.9STABLEOfficially supported.
3.10SEMI-STABLEBeta testing.
macOS 12 (Monterey)3.8STABLEOfficially supported.
3.9STABLEOfficially supported.
3.10SEMI-STABLEBeta testing.
Debian Buster / Ubuntu 18.043.8STABLEOfficially supported.
3.9STABLEOfficially supported.
3.10SEMI-STABLEBeta testing.
Debian Bullseye / Ubuntu 20.043.8STABLERecommended platform.
3.9STABLEOfficially supported.
3.10SEMI-STABLEBeta testing.
3.11NOT SUPPORTEDComing soon!
Ubuntu 22.043.8SEMI-STABLEBeta testing.
3.9SEMI-STABLEBeta testing.
Fedora 363.8STABLEOfficially supported.
CentOS 73.8STABLEOfficially supported.
3.9SEMI-STABLEBeta testing.
CentOS 83.9STABLEOfficially supported.
RHEL 73.8SEMI-STABLEBeta testing.
SUSE Enterprise 153.8SEMI-STABLEBeta testing.
Gentoo3.8STABLEOfficially supported.
3.9STABLEOfficially supported.
3.10SEMI-STABLEBeta testing.
+ v0.177.0 ******** @@ -81,6 +239,7 @@ v0.177.0 3.10 SEMI-STABLE Beta testing. + Fedora 35 3.8 diff --git a/doc/source/version_migrations/index.rst b/doc/source/version_migrations/index.rst index be49d357f..48995ae73 100644 --- a/doc/source/version_migrations/index.rst +++ b/doc/source/version_migrations/index.rst @@ -1,56 +1,71 @@ -=============== +======================= Version Migration Guide -=============== +======================= Why Migrate? ############ -We always recommend using the latest version of Covalent in order to get the latest improvements to our UI, use the latest features, and to take advantage of speedups in workflow execution. +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 0.177.0 -############ +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. + + .. code:: bash + + $ pip show covalent | grep Version + Version: 0.110.2 + +2. Stop the server. + + .. code:: bash + + $ covalent stop + Covalent server has stopped. + +3. Install the new version of Covalent using Pip. + + .. code:: bash -If you are currently using Covalent v0.110.2 you can upgrade to covalent v0.177.0 or later as follows. + $ pip install covalent==0.202.0 --upgrade + $ pip show covalent | grep Version + Version: 0.202.0 -First identify the currently installed version and then stop the server. +4. Migrate the database. -.. code:: bash + .. code:: bash - $ pip show covalent | grep Version - Version: 0.110.2 - $ covalent stop - Covalent server has stopped. + $ 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. -You can install the new version of Covalent using pip. +5. Start the server. -.. code:: bash + .. code:: bash - $ pip install covalent==0.177.0 --upgrade - $ pip show covalent | grep Version - Version: 0.177.0 - $ 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. - $ covalent start - Covalent server has started at http://localhost:48008 + $ covalent start + Covalent server has started at http://localhost:48008 -You should then be able to use our data migration tool to migrate any workflows you may want to port over to the new version of Covalent. +6. 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 :code:`e0ba03a2-fdc0-474e-9997-7fa8e82932c5` + For example, for a workflow with dispatch ID :code:`e0ba03a2-fdc0-474e-9997-7fa8e82932c5`: -.. code:: bash + .. code:: bash - $ covalent migrate-legacy-result-object ./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 + $ covalent migrate-legacy-result-object ./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 -You should now be able to navigate to the UI (http://localhost:48008) and see your existing workflows. +7. Navigate to the UI (http://localhost:48008) to view your workflows.