The repository for SedTRAILS: Sediment TRAnsport vIsualization and Lagrangian Simulator
- The
diagrams/c4folder was obtained from the original C4-PlantUML GitHub repository. The folder contains some of the files required to run PlantUML, as well as a short README.md that explains how to use the library. - You can read more about the PlantUML syntax on the PlantUML documentation. They provide extensive support, which may be an overkill at the moment.
- If you have the dependencies installed already, you can simply clone the repository and get started.
- TL;DR: the basic command to save your diagram to a PNG file:
# Bash terminal
plantuml -tpng <file.puml>Requirements
- Java
- GraphViz
[List and describe each step required to install the software. Use a description/example format. For example:]
[1. Install dependencies ]
[$ pip install -r requirements.txt]Read the contributing guidelines to know how can you take part in this project.
[TU Delft owns the copyrights of any software developed by TU Delft researchers. However, if the software is published as OSS under one of the licenses listed above, TU Delft agrees to transfer such rights to the Author(s) of the software. To claim the copyrights of a software include the text in WAIVER in your license file. Then you can include the following text as part of this section:]
© (2024) [Author(s)], Delft, The Netherlands.
[Include a CCF file (Citation File Format). See example in this repo: CITATION.cff. You can easily create the content of a CCF using this tool. ]
[CCF files can be converted to a multitude of formats, including BibTex, EndNote, codemeta, plain JSON, schema.org, RIS, and Zenodo JSON ]
| Role | Author |
|---|---|
| Conceptualization | |
| Funding acquisition | |
| Project management | |
| Research | |
| Software | |
| Supervision |
The SedTRAILS Project was supported by the Digital Competence Centre, Delft University of Technology.