{"id":37634192,"url":"https://github.com/rmcd-mscb/fluvial-particle-examples","last_synced_at":"2026-01-16T11:01:12.640Z","repository":{"id":332867634,"uuid":"1134387295","full_name":"rmcd-mscb/fluvial-particle-examples","owner":"rmcd-mscb","description":"🚧 DRAFT - Example datasets, tutorials, and visualizations for fluvial-particle simulations","archived":false,"fork":false,"pushed_at":"2026-01-16T01:16:52.000Z","size":38,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-16T02:43:13.594Z","etag":null,"topics":["draft","work-in-progress"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rmcd-mscb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-14T16:44:12.000Z","updated_at":"2026-01-16T01:16:57.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/rmcd-mscb/fluvial-particle-examples","commit_stats":null,"previous_names":["rmcd-mscb/fluvial-particle-examples"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/rmcd-mscb/fluvial-particle-examples","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Ffluvial-particle-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Ffluvial-particle-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Ffluvial-particle-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Ffluvial-particle-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rmcd-mscb","download_url":"https://codeload.github.com/rmcd-mscb/fluvial-particle-examples/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Ffluvial-particle-examples/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["draft","work-in-progress"],"created_at":"2026-01-16T11:01:12.241Z","updated_at":"2026-01-16T11:01:12.630Z","avatar_url":"https://github.com/rmcd-mscb.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fluvial Particle Examples\n\n\u003e **Note**\n\u003e This repository is a **DRAFT** and under active development. Example datasets and tutorials are incomplete.\n\nExample datasets, tutorials, and visualizations for [fluvial-particle](https://github.com/rmcd-mscb/fluvial-particle) - a Lagrangian particle tracking model for river flows.\n\n## Quick Start\n\n```bash\n# Clone this repository (includes Git LFS data)\ngit clone https://github.com/rmcd-mscb/fluvial-particle-examples.git\ncd fluvial-particle-examples\n\n# Install pixi (if not already installed)\ncurl -fsSL https://pixi.sh/install.sh | bash\n\n# Install all dependencies\npixi install\n\n# Run an example simulation\npixi run simulate --settings examples/basic/options_straight.py --output outputs/test\n\n# View the documentation\npixi run preview\n```\n\n## Contents\n\n### Examples\n\n| Example | Description |\n|---------|-------------|\n| [Quickstart](examples/basic/quickstart.qmd) | Run your first simulation |\n| [Straight Channel](examples/basic/straight_channel.qmd) | Basic 2D particle tracking |\n| [Time-Varying Flow](examples/time_varying/unsteady_flow.qmd) | Unsteady flow conditions |\n| [3D Tracking](examples/3d_tracking/vertical_mixing.qmd) | Full 3D velocity interpolation |\n\n### Datasets\n\n| Dataset | Description | Size |\n|---------|-------------|------|\n| `data/grids/straight_channel/` | Simple straight channel | ~5 MB |\n| `data/grids/time_series/` | Time-varying flow (5 timesteps) | ~20 MB |\n\n## Requirements\n\nThis project uses [pixi](https://pixi.sh) for dependency management. Pixi handles both conda packages (VTK, HDF5) and PyPI packages (fluvial-particle) in a single tool.\n\n### What pixi provides\n\n- **Python 3.11+** - Interpreter\n- **VTK** - Visualization Toolkit for grid I/O\n- **h5py** - HDF5 file handling\n- **NumPy** - Array operations\n- **Quarto** - Documentation rendering\n- **JupyterLab** - Interactive notebooks\n- **fluvial-particle** - The main simulation package\n\n## Usage\n\n### Pixi Tasks\n\n```bash\n# Run a simulation\npixi run simulate --settings \u003coptions.py\u003e --output \u003coutput_dir\u003e\n\n# Start JupyterLab\npixi run lab\n\n# Render documentation\npixi run render\n\n# Preview documentation site\npixi run preview\n\n# Clean outputs\npixi run clean\n```\n\n### Development\n\n```bash\n# Install with dev dependencies\npixi install -e dev\n\n# Run linter\npixi run lint\n\n# Format code\npixi run format\n```\n\n## Git LFS\n\nLarge data files (VTS, H5, etc.) are stored using [Git LFS](https://git-lfs.github.com/).\n\n```bash\n# Pull all LFS files\ngit lfs pull\n\n# Pull specific dataset\ngit lfs pull --include=\"data/grids/straight_channel/*\"\n\n# Check LFS status\ngit lfs status\n```\n\n## Documentation\n\nThe documentation is built with [Quarto](https://quarto.org/):\n\n```bash\n# Preview locally (with live reload)\npixi run preview\n\n# Build static site\npixi run render\n\n# Output is in _output/\n```\n\n## License\n\nMIT License - see [LICENSE](LICENSE) for details.\n\n## Related Projects\n\n- [fluvial-particle](https://github.com/rmcd-mscb/fluvial-particle) - The main simulation package\n- [fluvial-particle docs](https://fluvial-particle.readthedocs.io) - API documentation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmcd-mscb%2Ffluvial-particle-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frmcd-mscb%2Ffluvial-particle-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmcd-mscb%2Ffluvial-particle-examples/lists"}