{"id":22127456,"url":"https://github.com/fluiddyn/fluidsim","last_synced_at":"2025-04-05T02:06:27.158Z","repository":{"id":46666716,"uuid":"96229393","full_name":"fluiddyn/fluidsim","owner":"fluiddyn","description":":ocean: Framework for studying fluid dynamics with numerical simulations using Python (publish-only mirror). The main repo is hosted on https://foss.heptapod.net (Gitlab fork supporting Mercurial).","archived":false,"fork":false,"pushed_at":"2025-03-02T14:31:33.000Z","size":8354,"stargazers_count":59,"open_issues_count":0,"forks_count":9,"subscribers_count":6,"default_branch":"branch/default","last_synced_at":"2025-03-29T01:15:08.447Z","etag":null,"topics":["cfd","fluid-dynamics","high-performance-computing","mpi","navier-stokes","pseudo-spectral","turbulence"],"latest_commit_sha":null,"homepage":"https://foss.heptapod.net/fluiddyn/fluidsim","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fluiddyn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-04T14:59:54.000Z","updated_at":"2025-03-24T14:01:14.000Z","dependencies_parsed_at":"2022-07-20T19:02:18.300Z","dependency_job_id":"526b77ea-b8c9-4abd-9b97-315a2fca4b47","html_url":"https://github.com/fluiddyn/fluidsim","commit_stats":{"total_commits":2233,"total_committers":18,"mean_commits":"124.05555555555556","dds":0.5606806986117331,"last_synced_commit":"2fdb75d61212c05764f5eb95cc82f075325dffe7"},"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidsim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidsim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidsim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidsim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluiddyn","download_url":"https://codeload.github.com/fluiddyn/fluidsim/tar.gz/refs/heads/branch/default","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247276163,"owners_count":20912288,"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","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","fluid-dynamics","high-performance-computing","mpi","navier-stokes","pseudo-spectral","turbulence"],"created_at":"2024-12-01T17:18:54.903Z","updated_at":"2025-04-05T02:06:26.189Z","avatar_url":"https://github.com/fluiddyn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![FluidSim](https://foss.heptapod.net/fluiddyn/fluidsim/raw/branch/default/doc/logo.svg)\n\n[![Latest version](https://badge.fury.io/py/fluidsim.svg)](https://pypi.python.org/pypi/fluidsim/)\n![Supported Python versions](https://img.shields.io/pypi/pyversions/fluidsim.svg)\n[![Documentation status](https://readthedocs.org/projects/fluidsim/badge/?version=latest)](http://fluidsim.readthedocs.org)\n[![Chat room](https://img.shields.io/matrix/fluiddyn-users:matrix.org.svg)](https://matrix.to/#/#fluiddyn-users:matrix.org)\n[![Code coverage](https://codecov.io/gh/fluiddyn/fluidsim/branch/branch%2Fdefault/graph/badge.svg)](https://codecov.io/gh/fluiddyn/fluidsim)\n[![Heptapod CI](https://foss.heptapod.net/fluiddyn/fluidsim/badges/branch/default/pipeline.svg)](https://foss.heptapod.net/fluiddyn/fluidsim/-/pipelines)\n[![Github Actions](https://github.com/fluiddyn/fluidsim/actions/workflows/ci-linux.yml/badge.svg?branch=branch/default)](https://github.com/fluiddyn/fluidsim/actions)\n\nFluidsim is an extensible framework for studying fluid dynamics with numerical\nsimulations using Python. Fluidsim is an object-oriented library to develop\nFluidsim \"solvers\" (i.e. Python packages solving equations) by writing mainly\nPython code. The result is **very efficient** even compared to a pure Fortran\nor C++ code since the time-consuming tasks are performed by optimized compiled\nfunctions.\n\n**Documentation**: \u003chttps://fluidsim.readthedocs.io\u003e\n\n## Getting started\n\nTo try fluidsim without installation:\n[![Binder notebook](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fluiddyn/fluidsim/branch%2Fdefault?urlpath=lab/tree/doc/ipynb)\n\nFor a **basic installation** it should be sufficient to run:\n\n    pip install fluidsim\n\nor with [conda/mamba](https://github.com/conda-forge/miniforge):\n\n    conda install -c conda-forge fluidsim\n\nMuch more detailed instructions are given in [the\ndocumentation](https://fluidsim.readthedocs.io/en/latest/install.html).\n\n## How does it work?\n\nFluidsim is a\n[HPC](https://en.wikipedia.org/wiki/High-performance_computing) code. It\nis part of the wider project\n[FluidDyn](https://pypi.python.org/pypi/fluiddyn/) and its\npseudospectral solvers rely on the library\n[fluidfft](http://fluidfft.readthedocs.io) to use very efficient FFT\nlibraries. Fluidfft is written in C++, Cython and Python. Fluidfft and\nfluidsim take advantage of\n[Pythran](https://github.com/serge-sans-paille/pythran), an\nahead-of-time compiler which produces very efficient binaries by\ncompiling Python via C++11.\n\nAn advantage of a CFD code written mostly in Python is that, to run\nsimulations and analyze the results, the users communicate (possibly\ninteractively) together and with the machine with Python, which is\nnowadays among the best languages to do these tasks. Moreover, it is\nmuch simpler and faster than with pure Fortran or C++ codes to add any\ncomplicated analysis or to write a modified solver. Fluidsim can also be\nused to extend existing solvers with Python interfaces such as\n[Basilisk](http://basilisk.fr).\n\nWe have created fluidsim to be **easy and nice to use and to develop**,\n**efficient** and **robust**.\n\n*Keywords and ambitions*: fluid dynamics research with Python (\u003e=3.10);\nmodular, object-oriented, collaborative, tested and documented, free and\nopen-source software.\n\n## License\n\nFluidSim is distributed under the\n[CeCILL](http://www.cecill.info/index.en.html) License, a GPL compatible\nfrench license.\n\n## Metapapers and citations\n\nIf you use FluidSim to produce scientific articles, please cite our\nmetapapers presenting the [FluidDyn\nproject](https://openresearchsoftware.metajnl.com/articles/10.5334/jors.237/),\n[FluidFFT](https://openresearchsoftware.metajnl.com/articles/10.5334/jors.238/),\nand\n[FluidSim](https://openresearchsoftware.metajnl.com/articles/10.5334/jors.239/):\n\n    @article{fluiddyn,\n    doi = {10.5334/jors.237},\n    year = {2019},\n    publisher = {Ubiquity Press,  Ltd.},\n    volume = {7},\n    author = {Pierre Augier and Ashwin Vishnu Mohanan and Cyrille Bonamy},\n    title = {{FluidDyn}: A Python Open-Source Framework for Research and Teaching in Fluid Dynamics\n        by Simulations,  Experiments and Data Processing},\n    journal = {Journal of Open Research Software}\n    }\n\n    @article{fluidfft,\n    doi = {10.5334/jors.238},\n    year = {2019},\n    publisher = {Ubiquity Press,  Ltd.},\n    volume = {7},\n    author = {Ashwin Vishnu Mohanan and Cyrille Bonamy and Pierre Augier},\n    title = {{FluidFFT}: Common {API} (C$\\mathplus\\mathplus$ and Python)\n        for Fast Fourier Transform {HPC} Libraries},\n    journal = {Journal of Open Research Software}\n    }\n\n    @article{fluidsim,\n    doi = {10.5334/jors.239},\n    year = {2019},\n    publisher = {Ubiquity Press,  Ltd.},\n    volume = {7},\n    author = {Mohanan, Ashwin Vishnu and Bonamy, Cyrille and Linares, Miguel\n        Calpe and Augier, Pierre},\n    title = {{FluidSim}: {Modular}, {Object}-{Oriented} {Python} {Package} for\n        {High}-{Performance} {CFD} {Simulations}},\n    journal = {Journal of Open Research Software}\n    }\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluiddyn%2Ffluidsim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffluiddyn%2Ffluidsim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluiddyn%2Ffluidsim/lists"}