Commit b37e1701 authored by Sævik Pål Næverlid's avatar Sævik Pål Næverlid
Browse files

Add readme file

parent cb9e8683
# Chemicals
The module represents passive particles that have a vertical migration rate due
to upwelling/downwelling and vertical turbulence.
## Usage
Modify `ladim.yaml` and `particles.rls` to suit your needs.
Common changes applied to `ladim.yaml`:
- Start date of simulation (`time_control.start_time`)
- Stop date of simulation (`time_control.stop_time`)
- Forcing input file (`gridforce.input_file`)
- Horizontal diffusion parameter (`numerics.diffusion`)
- Time step length (`numerics.dt`)
- Output frequency (`output_variables.outper`)
- Vertical diffusion parameter (`ibm.vertical_mixing`)
The file `particles.rls` is a tab-delimited text file containing particle
release time and location, as well as particle attributes at the release time.
The order of the columns is given by the entry `particle_release.variables`
within `ladim.yaml`.
Finally, copy `ladim.yaml` and `particles.rls` to a separate directory and
run `ladim` here.
## Output
The simulation result is stored in a file specified by the `files.output_file`
entry in `ladim.yaml`. The output variables are specified by the
`output_variables` entries.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment