Installation

Python

The project repository contains a scripts directory that includes operating system-specific installation scripts for Python, ensuring a smooth setup across various environments.

  • macOS: The run_install_python.zsh script is available for macOS users. This script is adapted for the Zsh shell, which is the standard shell on recent versions of macOS, and it streamlines the Python installation.

  • Ubuntu: For users on Ubuntu, the run_install_python.sh script is provided. This Bash script is created to operate within the default shell environment of Ubuntu, facilitating the Python installation process.

  • Windows: The run_install_python.bat script is tailored for users on Windows systems. It is designed to be run in the Command Prompt and automates the Python installation process on Windows.

These scripts are named according to the convention run_install_python.<ext>, where <ext> corresponds to the script extension appropriate for the target operating system and shell environment (e.g., .bat for Windows, .sh for Ubuntu Bash, .zsh for macOS). Users are recommended to execute the script matching their OS to ensure an efficient Python setup.

Miniconda

The scripts directory includes a collection of operating system-specific scripts named run_install_miniconda to streamline the installation of Miniconda. These scripts are designed to cater to the needs of different environments, making the setup process efficient and user-friendly.

  • Windows CMD Shell: The run_install_miniconda.bat script is tailored for the Windows CMD shell. It automates the Miniconda installation process on Windows, providing a hassle-free setup with a simple double-click or command line execution.

  • Ubuntu Bash Shell: Ubuntu users can take advantage of the run_install_miniconda.sh script. This Bash script is intended for use within the Ubuntu terminal, encapsulating the necessary commands to install Miniconda seamlessly on Ubuntu systems.

  • macOS Zsh Shell: For macOS, the run_install_miniconda.zsh script is available. It is optimized for the Zsh shell, which is the default on recent versions of macOS. This script simplifies the installation and configuration of Miniconda, ensuring a smooth integration with macOS.

Each script in the scripts directory is named to reflect its compatibility with the corresponding operating system and shell environment. Users are encouraged to execute the script that matches their OS for a smooth and error-free Miniconda installation experience.

Python Libraries

The project’s Python dependencies are managed partly through Conda and partly through pip. To facilitate a straightforward installation process, a Makefile is provided at the root of the project.

  • Development Environment: Run the command make conda-dev from the terminal to set up a development environment. This will install the necessary Python libraries using Conda and pip as specified for development purposes.

The Makefile targets abstract away the complexity of managing multiple package managers and streamline the environment setup. It is crucial to have both Conda and the appropriate pip tool available in your system’s PATH to utilize the Makefile commands successfully.