Development Setup

Developers and contributors can set up a local development environment to work on the SedTRAILS codebase. Follow the steps below to get started.

  1. Make sure Python (3.13 or newer) and a code editor (e.g., Visual Studio Code) is installed.

  2. Fork the SedTRAILS repository on GitHub to your own account. If it is your first time using contritubing to SedTRAILS, please read the contributing guidelines.

  3. Clone the SedTRAILS repository from github in your desired directory:

git clone git@github.com:<your-user-name>/sedtrails.git

  1. Change the directory:

cd sedtrails

  1. Change to the development branch:

git swiltch dev

  1. Create and activate a virtual environment to manage dependencies using the tool of your choice. For example, using venv or conda.

# If using venv
python -m venv .venv
source .venv/bin/activate  # On Windows use `.venv\Scripts\activate`

# If using conda
conda create --name sedtrails-dev python=3.13
conda activate sedtrails-dev

  1. Install the dependencies: (more details)

pip install -e .[dev]

  1. Confirming the installation by typing on the terminal:

sedtrails -v

# The installed version should be displayed

For help:

sedtrails -h

Simulation Test

To fullly test your development environment, you can run a sample simulation using a provided dataset.

  1. Download the dataset file named inlet_sedtrails.nc from this link.

  2. Change the directory:

cd examples

  1. In the file config.example.yaml, update the directory for input_data to read the downloaded dataset: input_data: ./<path-to/inlet_sedtrails.nc

  2. Run the model:

sedtrails run -c config.example.yaml