Installing csc-tools

The ACSC provides a Python command-line tool to aid contributors in preparing data for upload. This tool provides a means of validating that user-supplied data is in the correct format for upload to the ACSC servers.

Requirements

csc-tools requires Python version 3.6 or higher. To check if your environment is configured with an appropriate version of Python, execute the following command in a terminal:

python --version

Installation of csc-tools also requires pip version 10.0 or higher. To check if your environment is configured with an appropriate version of pip, execute the following command in a terminal:

pip --version

Installation

To install csc-tools, execute the following command in a terminal:

pip install --upgrade --force-reinstall git+https://github.com/ATB-UQ/csc-tools@master

Note

The --upgrade and --force-reinstall flags ensure that csc-tools is reinstalled in cases where a preexisting installation of csc-tools is present.

To confirm that the csc-tools installation is working, try running the program by executing the following command in a terminal:

csct --version

If the version number of csct is displayed, the installation has completed successfully and csc-tools is ready to be used.