sedtrails
Sediment particle tracking model repository - WORK IN PROGRESS
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary
Repository
Sediment particle tracking model repository - WORK IN PROGRESS
Basic Info
- Host: GitHub
- Owner: sedtrails
- License: mit
- Language: Python
- Default Branch: dev
- Homepage: https://sedtrails.github.io/sedtrails/
- Size: 17.5 MB
Statistics
- Stars: 2
- Watchers: 1
- Forks: 9
- Open Issues: 50
- Releases: 0
Metadata Files
README.md
SedTRAILS
Sediment TRAnsport vIsualization and Lagrangian Simulator.
Installation
SedTRAILS requires Python 3.12 and above, but it is likely to work with Python 3.10 and above.
- Clone the repository: ```bash
git clone https://github.com/sedtrails/sedtrails.git ```
- Change the directory:
bash cd sedtrails - Install the dependencies:
bash pip install .
Software Architecture
The diagrams/c4 directory was obtained from the C4-PlantUML GitHub repository. The directory contains some of the files required to run PlantUML, as well as a short README.md that explains how to use the library.
Requirements - Java - GraphViz
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 requirements already installed, you can simply clone the repository and get started.
- TL;DR: the basic command to save your diagram to a PNG file:
shell
# Bash terminal
plantuml -tpng <file.puml>
Contributing Guidelines
Read the contributing guidelines to know how can you take part in this project.
License
SetTRAILS is licensed under the MIT License.
© (2025) SedTRAILS Team, Delft, The Netherlands.
Citation
Pannozzo, N., Shafiei, H., van Westen, B., Pearson, S. G., Reyns, J., & Aguilera Chaves, M. SedTRAILS (Version 0.1) [Computer software]
Author Contributions:
| Role | Author | |------|--------| | Conceptualization | | | Funding acquisition | | | Project management | | | Research | | | Software | | | Supervision | |
Acknowlegdements
The development of SedTRAILS Software was supported by the Digital Competence Centre, Delft University of Technology.
Owner
- Name: SedTRAILS
- Login: sedtrails
- Kind: organization
- Location: Netherlands
- Repositories: 1
- Profile: https://github.com/sedtrails
Development team for SedTRAILS model
Citation (CITATION.cff)
# YAML 1.2
---
authors:
- family-names: Pannozzo
given-names: Natascia
email: N.Pannozzo@tudelft.nl
orcid: 'https://orcid.org/0000-0002-8082-9251'
affiliation: Delft University of Technology
- family-names: Shafiei
given-names: Hassan
email: h.shafiei@tudelft.nl
orcid: 'https://orcid.org/0000-0000-0000-0000'
affiliation: Delft University of Technology
- family-names: van Westen
given-names: Bart
email: Bart.vanWesten@deltares.nl
orcid: 'https://orcid.org/0000-0001-7903-6062'
affiliation: Deltares
- family-names: Pearson
given-names: Stuart Grant
email: s.g.pearson@tudelft.nl
orcid: 'https://orcid.org/0000-0002-3986-4469'
affiliation: Delft University of Technology
- family-names: Reyns
given-names: Johan
email: johan.reyns@deltares.nl
orcid: 'https://orcid.org/0000-0002-0849-1532'
affiliation: Deltares/IHE Delft
- family-names: Aguilera Chaves
given-names: Monica
email: monica.aguilerachaves@deltares.nl
orcid: 'https://orcid.org/0000-0000-0000-0000'
affiliation: Deltares
cff-version: 1.2.0
keywords:
- awesome-test
- software
message: If you use this software, please cite it using these metadata.
title: SedTRAILS
version: '0.1'
license: MIT
...
GitHub Events
Total
- Create event: 10
- Issues event: 201
- Watch event: 3
- Delete event: 11
- Issue comment event: 203
- Push event: 124
- Public event: 1
- Pull request review event: 216
- Pull request review comment event: 179
- Pull request event: 195
- Fork event: 8
Last Year
- Create event: 10
- Issues event: 201
- Watch event: 3
- Delete event: 11
- Issue comment event: 203
- Push event: 124
- Public event: 1
- Pull request review event: 216
- Pull request review comment event: 179
- Pull request event: 195
- Fork event: 8
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 127
- Total pull requests: 117
- Average time to close issues: 11 days
- Average time to close pull requests: 4 days
- Total issue authors: 8
- Total pull request authors: 8
- Average comments per issue: 0.35
- Average comments per pull request: 0.44
- Merged pull requests: 78
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 127
- Pull requests: 117
- Average time to close issues: 11 days
- Average time to close pull requests: 4 days
- Issue authors: 8
- Pull request authors: 8
- Average comments per issue: 0.35
- Average comments per pull request: 0.44
- Merged pull requests: 78
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- manuGil (53)
- aysunrhn (35)
- sgpearson17 (19)
- jreyns (10)
- bartvanwesten (3)
- Hassan-Shafiei (3)
- monica-aguil (2)
- npannozzo (2)
Pull Request Authors
- manuGil (47)
- aysunrhn (30)
- jreyns (11)
- sgpearson17 (10)
- Hassan-Shafiei (8)
- npannozzo (4)
- bartvanwesten (4)
- monica-aguil (3)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v4 composite
- actions/setup-python v3 composite
- sphinx-notes/pages v3 composite
- Sphinx ==8.2.0
- myst-parser ==4.0.1
- sphinx-rtd-theme ==3.0.2
- flake8
- jsonschema
- matplotlib
- myst-parser 4.0.1.*
- numpy
- pandas
- pytest
- python 3.13.*
- pyyaml
- sphinx 8.2.0.*
- sphinx-rtd-theme
- typer
- xarray