CSD compatibility

Please check the online version of this page: https://gphl.gitlab.io/grade2_docs/csd_compatibility.html before updating your CSD installation. The online page is updated when new CSD releases are made.

Grade2 obtains data from the Cambridge Structural Database (CSD) using the CSD Python API and you must have an CSD installation to use Grade2. Because the CSD and BUSTER installations are separate, incompatibilities can arise. This page shows which recent releases of the two packages work together. Releases made in the past year are listed.

Please note that the CSD update procedure is, to our knowledge irreversible and you can only download the latest version. So if you update the code to an incompatible version and there is a problem you may well be stuck.

Alterations in Grade2 release 1.6.0 (June 2024)

Note

Please note that the configuration procedure has been altered in Grade2 release 1.6.0 in June 2024. Please see the Configuration Instructions for details of the new method that involves setting environment variable BDG_CSD_TOP_DIRECTORY.

Note

To simplify support, from the next Grade2 release (scheduled autumn 2024) Grade2 will not work with CSD-Core releases older than 2024.1.

Note

If you are using an old version of CSD-Core you are strongly recommended to update to CSD-Core 2024.1

Linux

Linux Grade2/CSD Compatibility

Grade2 version (build date)

CSD-Core version (release date)

Work together?

1.6.0 (11 June 2024)

CSD 2024.1 (March 2024)

Yes highly recommended

CSD 2023.3 (November 2023)

Yes but upgrade to 2024.1

CSD 2023.2 (July 2023)

Yes but upgrade to 2024.1

CSD 2023.1 (April 2023)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7" but upgrade to 2024.1

CSD 2022.3 (November 2022)

No

1.5.0 (12 January 2024)

CSD 2024.1 (March 2024)

Yes

CSD 2023.3 (November 2023)

Yes

CSD 2023.2 (July 2023)

Yes

CSD 2023.1 (April 2023)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7"

CSD 2022.3 (November 2022)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7"

1.4.1 (18 July 2023)

CSD 2024.1 (March 2024)

Yes

CSD 2023.3 (November 2023)

Yes

CSD 2023.2 (July 2023)

Yes

CSD 2023.1 (April 2023)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7"

CSD 2022.3 (November 2022)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7"

1.4.0 (22 May 2023)

CSD 2023.2 (July 2023) and following

No

CSD 2023.1 (April 2023)

Yes

CSD 2022.3 (November 2022)

Yes

MacOS

MacOS Grade2/CSD Compatibility

Grade2 version (build date)

CSD-Core version (release date)

Work together?

1.6.0 (11 June 2024)

CSD 2024.1 (March 2024)

Yes highly recommended

CSD 2023.3 (November 2023)

Yes but upgrade to 2024.1

CSD 2023.2 (July 2023)

Yes but upgrade to 2024.1

CSD 2023.1 (April 2023)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7" but upgrade to 2024.1

CSD 2022.3 (November 2022)

No

1.5.0 (12 January 2024)

CSD 2024.1 (March 2024)

Yes

CSD 2023.3 (November 2023)

Yes

CSD 2023.2 (July 2023)

Yes

CSD 2023.1 (April 2023)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7"

CSD 2022.3 (November 2022)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7"

1.4.1 (18 July 2023)

CSD 2024.1 (March 2024)

Yes

CSD 2023.3 (November 2023)

Yes

CSD 2023.2 (July 2023)

Yes

CSD 2023.1 (April 2023)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7"

CSD 2022.3 (November 2022)

Yes with BDG_GRADE2_PYTHON_VERSION="3.7"

1.4.0 (22 May 2023)

CSD 2023.2 (July 2023) and following

No

CSD 2023.1 (April 2023)

Yes

CSD 2022.3 (November 2022)

Yes

Using Grade2 release 1.4.1 (and following) with old CSD releases

CSD release 2023.2 (July 2023) contained an update to the miniconda environment included with CSD from Python 3.7 to Python 3.9. Grade2 is distributed with BUSTER within in a separate miniconda environment. In order to work together the two Python versions of these two miniconda environments must be the same. Grade2 in all versions up to 1.4.0 used a Python 3.7 miniconda environment and so will not work with the new CSD release 2023.2 (July 2023).

From Grade2 release 1.4.1 includes both a Python 3.9 miniconda environment to work with the new CSD release 2023.2 (July 2023) and a Python 3.7 miniconda environment to work with older CSD releases. We will continue to include a Python 3.7 miniconda environment until July 2024 to support older CSD releases.

The easiest way to ensure compatibility is to update both BUSTER (and hence Grade2) and CSD.

If you wish to use an older installation of CSD with Grade2 following release 1.4.1 or following set the environment variable BDG_GRADE2_PYTHON_VERSION to 3.7. Users of bash/ksh/zsh shells can do this by:

export BDG_GRADE2_PYTHON_VERSION="3.7"

Users of csh can set the environment variable by

setenv BDG_GRADE2_PYTHON_VERSION "3.7"

It is best practice that Grade2 environment variables are are added to the BUSTER setup_local.sh or setup_local.csh file as explained in Grade2 environment variables section.

Once you update CSD you will need to make sure that BDG_GRADE2_PYTHON_VERSION is not set for Grade2 to work.

(Page updated 11 June 2024)