Installation

If you prefer to run TIMSCONVERT locally via the command line interface, you can set up a conda environment to do so. Please note that TIMSCONVERT should be run under Windows or Linux. macOS is not supported.

Installing on Windows

  1. Download and install Anaconda for Windows if not already installed. Follow the prompts to complete installation.

  2. Download and install Git for Windows if not already installed.

  3. Run Anaconda Prompt.

  4. Create a conda instance.

    conda create -n timsconvert python=3.11

  5. Activate conda environment.

    conda activate timsconvert

  6. Install dependencies.

    pip install -r https://raw.githubusercontent.com/gtluu/timsconvert/main/requirements.txt

  7. Install TIMSCONVERT.

    pip install git+https://github.com/gtluu/timsconvert

  8. TIMSCONVERT is now ready to use. See the Local Usage page for basic usage of TIMSCONVERT.

Installing on Linux

Please note that while these instructions should apply to most Linux distros, TIMSCONVERT is tested on Ubuntu 22.04.3 LTS. We recommend using this distro if you encounter compatibility issues in others.

  1. If not already installed, download and install Anaconda for Linux. Anaconda3-2023.07-2 for Linux is used as an example here.

    • Alternatively, the script can be downloaded in the Terminal using the following command.

    wget https://repo.anaconda.com/archive/Anaconda3-2023.07-2-Linux-x86_64.sh

  2. If not already installed, install git. On Ubuntu 22.04.3 LTS, this can be done using the following command.

    sudo apt-get install git

  1. Install Anaconda for Linux via the bash script that was downloaded. After installation, restart the terminal (or open a new terminal window).

    bash [path to]/Anaconda3-2023.07-2-Linux-x86_64.sh

  2. In the terminal, create a conda virtual environment.

    conda create -n timsconvert python=3.11

  3. Activate conda environment.

    conda activate timsconvert

  4. Install dependencies.

    pip install -r https://raw.githubusercontent.com/gtluu/timsconvert/main/requirements.txt

  5. Install TIMSCONVERT.

    pip install git+https://github.com/gtluu/timsconvert

  6. TIMSCONVERT is now ready to use. See the Local Usage page for basic usage of TIMSCONVERT.