First Steps¶

To get started, you’ll first need to clone the repository, which contains essential scripts for various operating systems. After cloning, you will use these scripts to install the necessary foundational software. Finally, you will complete the repository-specific installation to set up your environment correctly. Detailed instructions for each of these steps are provided below.

Cloning the Repository¶

Start by cloning the io-data-sources repository. This repository contains essential scripts and configurations needed for the project.

git clone https://github.com/io-aero/io-olympus/io-data-sources

Install Foundational Software¶

Once you have successfully cloned the repository, navigate to the cloned directory. Within the scripts folder, you will find scripts tailored for various operating systems. Proceed with the subsection that corresponds to your operating system for further instructions.

macOS¶

To set up the project on a macOS system, the following steps should be performed in a terminal window within the repository directory:

a. Grant Execute Permission to Installation Scripts¶

Provide execute permissions to the installation scripts:

chmod +x scripts/*.zsh

b. Install Python and pip¶

Run the script to install Python and pip:

./scripts/run_install_python.zsh

c. Install Miniconda and the Correct Python Version¶

Use the following script to install Miniconda and set the right Python version:

./scripts/run_install_miniconda.zsh

d. Close the Terminal Window¶

Once all installations are complete, close the terminal window.

Ubuntu¶

To set up the project on an Ubuntu system, the following steps should be performed in a terminal window within the repository directory:

a. Grant Execute Permission to Installation Scripts¶

Provide execute permissions to the installation scripts:

chmod +x scripts/*.sh

b. Install Python and pip¶

Run the script to install Python and pip:

./scripts/run_install_python.sh

c. Install Miniconda and the Correct Python Version¶

Use the following script to install Miniconda and set the right Python version:

./scripts/run_install_miniconda.sh

d. Close the Terminal Window¶

Once all installations are complete, close the terminal window.

Windows 10/11¶

To set up the project on a Windows 10/11 system, the following steps should be performed in a command prompt (cmd) within the repository directory:

a. Install Python and pip¶

Run the script to install Python and pip:

scripts/run_install_python.bat

b. Install Miniconda and the Correct Python Version¶

Use the following script to install Miniconda and set the right Python version:

scripts/run_install_miniconda.bat

c. Close the Command Prompt¶

Once all installations are complete, close the command prompt.

Repository-Specific Installation¶

After installing the basic software, you need to perform installation steps specific to the io-data-sources repository. This involves setting up project-specific dependencies and environment configurations. To perform the repository-specific installation, the following steps should be performed in a command prompt or a terminal window (depending on the operating system) within the repository directory.

Setting Up the Python Environment¶

To begin, you’ll need to set up the Python environment using Miniconda, which is already pre-installed. You can use the provided Makefile for managing the environment.

make conda-dev

This command will create and configure the virtual environment iodatasources for your Python project, ensuring a clean and reproducible development or production environment.