{"id":32747877,"url":"https://github.com/diogoribeiro7/vortex2d","last_synced_at":"2026-05-12T23:35:46.681Z","repository":{"id":320700089,"uuid":"1083042781","full_name":"DiogoRibeiro7/vortex2d","owner":"DiogoRibeiro7","description":"2D vortex particle method (Gaussian-core) with RK4, viscosity, plots, animations","archived":false,"fork":false,"pushed_at":"2025-10-25T10:14:32.000Z","size":64,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2025-10-25T11:31:49.759Z","etag":null,"topics":["cfd","matplotlib","numpy","python","simulation","vortex-method"],"latest_commit_sha":null,"homepage":"https://github.com/DiogoRibeiro7/vortex2d","language":"Python","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/DiogoRibeiro7.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-25T08:20:18.000Z","updated_at":"2025-10-25T10:14:36.000Z","dependencies_parsed_at":"2025-10-25T11:31:51.593Z","dependency_job_id":"fa3425ce-1d9b-455c-b78d-b65e8c11892b","html_url":"https://github.com/DiogoRibeiro7/vortex2d","commit_stats":null,"previous_names":["diogoribeiro7/vortex2d"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/DiogoRibeiro7/vortex2d","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiogoRibeiro7%2Fvortex2d","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiogoRibeiro7%2Fvortex2d/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiogoRibeiro7%2Fvortex2d/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiogoRibeiro7%2Fvortex2d/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DiogoRibeiro7","download_url":"https://codeload.github.com/DiogoRibeiro7/vortex2d/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiogoRibeiro7%2Fvortex2d/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":282521097,"owners_count":26683141,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-03T02:00:05.676Z","response_time":108,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["cfd","matplotlib","numpy","python","simulation","vortex-method"],"created_at":"2025-11-03T20:01:24.312Z","updated_at":"2025-11-03T20:03:29.565Z","avatar_url":"https://github.com/DiogoRibeiro7.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# vortex2d — Gaussian-Core Vortex Method in Python\n\n[![PyPI](https://img.shields.io/pypi/v/vortex2d.svg)](https://pypi.org/project/vortex2d/)\n[![CI](https://github.com/diogogoribeiro7/vortex2d/actions/workflows/ci_hardening.yml/badge.svg)](https://github.com/diogogoribeiro7/vortex2d/actions)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n\n\u003e **vortex2d** is a lightweight 2‑D vortex particle solver with Gaussian cores.  \n\u003e Written in pure Python with optional Numba acceleration, featuring clean APIs, validated physics, and extensible design for research and teaching.\n\n---\n\n## ✨ Features\n- Biot–Savart velocity via Gaussian-core regularization  \n- Multiple backends: direct, FFT-periodic, Barnes–Hut treecode  \n- Integrators: Euler, RK2, RK4, adaptive RK2/3  \n- Diffusion: core-spreading and PSE (Particle Strength Exchange)  \n- Remeshing and merging kernels (B-spline, conservative)  \n- Visualization: Matplotlib and Plotly interactive backends  \n- Optional Numba JIT + chunked evaluation  \n- Poetry + PyPI + Conda packaging  \n- Validation suite: Lamb–Oseen, dipole, Kelvin circulation  \n\n---\n\n## ⚙️ Installation\n\n### PyPI\n```bash\npip install vortex2d\n```\n\n### Development\n```bash\ngit clone https://github.com/diogogoribeiro7/vortex2d.git\ncd vortex2d\npoetry install --with dev\n```\n\n---\n\n## 🧩 Quick Examples\n\n### Lamb–Oseen vortex\n```python\nimport numpy as np\nfrom vortex2d import VortexSystem2D, plot_snapshot\n\nx, g = VortexSystem2D.lamb_oseen_vortex(center=(0,0), circulation=1.0, sigma=0.03)\nvm = VortexSystem2D(x, g, sigma=0.03, nu=1e-4)\nplot_snapshot(vm, domain=(-0.5,0.5,-0.5,0.5), nx=96, ny=72)\n```\n\n### Dipole translation\n```python\nfrom vortex2d import VortexSystem2D, run_animation, AnimationConfig\n\nsigma = 0.03\nx, g = VortexSystem2D.vortex_dipole(distance=0.2, sigma=sigma)\nvm = VortexSystem2D(x, g, sigma=sigma, nu=0.0)\n\ncfg = AnimationConfig(render_mode=\"quiver\")\nrun_animation(vm, steps=200, dt=0.004, config=cfg, save_path=\"dipole.mp4\")\n```\n\n\n---\n\n## 🧪 Validation Tests\n| Case | Quantity checked | Reference |\n|------|------------------|------------|\n| Lamb–Oseen | L² velocity error | Analytic vortex decay |\n| Dipole | Translation speed `U = Γ / (2πa)` | Analytical dipole |\n| Kelvin’s theorem | Circulation invariance | Inviscid flow |\n| Temporal order | RK accuracy | Manufactured velocity field |\n\n---\n\n## 🧱 Repository Layout\n```\nsrc/vortex2d/         # Core solver, integrators, IO, visualization\ntests/                # Unit + validation tests\nexamples/             # Demos (dipole, Lamb–Oseen)\nconda/recipe/         # Conda-forge recipe\ndocs/                 # MkDocs site\n.github/workflows/    # CI, release, docs\n```\n\n---\n\n## 🔬 Development \u0026 CI\n- Ruff format gate + mypy --strict\n- Pre-commit hooks for hygiene\n- Perf smoke (pytest-benchmark) on matrix backend/numba\n\n---\n\n## 📦 Release\n- Conventional Commits → auto changelog (release-please)\n- Tag `v*.*.*` → PyPI publish via Poetry\n- Conda recipe scaffold\n\n---\n\n## 🗺 Roadmap\nSee [ROADMAP.md](ROADMAP.md) for detailed milestones.\n\n---\n\n## 🤝 Contributing\n1. Follow Conventional Commits (`feat(core): ...`).\n2. Run `pre-commit run -a` before pushing.\n3. Add docstrings and type hints.\n\n---\n\n## 🪪 License\nMIT © 2025 — maintained by Diogo Ribeiro\n\n---\n\n## 📚 Citation\n```\n@software{vortex2d2025,\n  author = {Ribeiro, Diogo},\n  title  = {vortex2d: Gaussian-Core Vortex Method in Python},\n  year   = {2025},\n  url    = {https://github.com/diogogoribeiro7/vortex2d}\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiogoribeiro7%2Fvortex2d","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiogoribeiro7%2Fvortex2d","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiogoribeiro7%2Fvortex2d/lists"}