| Name | pylbm JSON |
| Version |
0.10.0
JSON |
| download |
| home_page | None |
| Summary | A flexible Python package for lattice Boltzmann method |
| upload_time | 2024-04-07 05:20:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | None |
| keywords |
boltzmann
lattice
methods
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
pylbm
=====
|Binder| |GithubAction| |Doc badge| |Gitter Badge|
.. |Binder| image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/pylbm/pylbm/master
.. |GithubAction| image:: https://github.com/pylbm/pylbm/workflows/ci/badge.svg
.. |Gitter Badge| image:: https://badges.gitter.im/pylbm/pylbm.svg
:alt: Join the chat at https://gitter.im/pylbm/pylbm
:target: https://gitter.im/pylbm/pylbm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |Doc badge| image:: https://readthedocs.org/projects/pylbm/badge/?version=latest
:target: http://pylbm.readthedocs.io/en/latest/
pylbm is an all-in-one package for numerical simulations using Lattice Boltzmann solvers.
This package gives all the tools to describe your lattice Boltzmann scheme in 1D, 2D and 3D problems.
We choose the D'Humières formalism to describe the problem. You can have complex geometry with a set of simple shape like circle, sphere, ...
pylbm performs the numerical scheme using Cython, NumPy or Loo.py from the scheme and the domain given by the user. Pythran and Numba wiil be available soon. pylbm has MPI support with mpi4py.
Installation
============
You can install pylbm in several ways
**With mamba or conda**
.. code:: bash
mamba install pylbm -c conda-forge
.. code:: bash
conda install pylbm -c conda-forge
With Pypi
---------
.. code::
pip install pylbm
or
.. code::
pip install pylbm --user
From source
-----------
You can also clone the project and install the latest version
.. code::
git clone https://github.com/pylbm/pylbm
To install pylbm from source, we encourage you to create a fresh environment using conda.
.. code::
conda create -n pylbm_env python
As mentioned at the end of the creation of this environment, you can activate it
using the comamnd line
.. code::
conda activate pylbm_env
Now, you just have to go into the pylbm directory that you cloned and install
the dependencies
.. code::
conda install --file requirements-dev.txt -c conda-forge
and then, install pylbm
.. code::
pip install .
For more information about what you can achieve with pylbm, take a look at the documentation
`<http://pylbm.readthedocs.io>`_
Raw data
{
"_id": null,
"home_page": null,
"name": "pylbm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Boltzmann, Lattice, Methods",
"author": null,
"author_email": "Benjamin Graille <benjamin.graille@universite-paris-saclay.fr>, Loic Gouarin <loic.gouarin@polytechnique.edu>",
"download_url": "https://files.pythonhosted.org/packages/c7/4d/36d5edd01f940acea4dc79adbb061b7e45d4a6d12224fbb3ea75d6552c6c/pylbm-0.10.0.tar.gz",
"platform": null,
"description": "pylbm\n=====\n\n|Binder| |GithubAction| |Doc badge| |Gitter Badge|\n\n.. |Binder| image:: https://mybinder.org/badge.svg\n :target: https://mybinder.org/v2/gh/pylbm/pylbm/master\n.. |GithubAction| image:: https://github.com/pylbm/pylbm/workflows/ci/badge.svg\n.. |Gitter Badge| image:: https://badges.gitter.im/pylbm/pylbm.svg\n :alt: Join the chat at https://gitter.im/pylbm/pylbm\n :target: https://gitter.im/pylbm/pylbm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n.. |Doc badge| image:: https://readthedocs.org/projects/pylbm/badge/?version=latest\n :target: http://pylbm.readthedocs.io/en/latest/\n\npylbm is an all-in-one package for numerical simulations using Lattice Boltzmann solvers.\n\nThis package gives all the tools to describe your lattice Boltzmann scheme in 1D, 2D and 3D problems.\n\nWe choose the D'Humi\u00e8res formalism to describe the problem. You can have complex geometry with a set of simple shape like circle, sphere, ...\n\npylbm performs the numerical scheme using Cython, NumPy or Loo.py from the scheme and the domain given by the user. Pythran and Numba wiil be available soon. pylbm has MPI support with mpi4py.\n\nInstallation\n============\n\nYou can install pylbm in several ways\n\n**With mamba or conda**\n\n.. code:: bash\n\n mamba install pylbm -c conda-forge\n\n.. code:: bash\n\n conda install pylbm -c conda-forge\n\nWith Pypi\n---------\n\n.. code::\n\n pip install pylbm\n\nor\n\n.. code::\n\n pip install pylbm --user\n\nFrom source\n-----------\n\nYou can also clone the project and install the latest version\n\n.. code::\n\n git clone https://github.com/pylbm/pylbm\n\nTo install pylbm from source, we encourage you to create a fresh environment using conda.\n\n.. code::\n\n conda create -n pylbm_env python\n\nAs mentioned at the end of the creation of this environment, you can activate it\nusing the comamnd line\n\n.. code::\n\n conda activate pylbm_env\n\nNow, you just have to go into the pylbm directory that you cloned and install\nthe dependencies\n\n.. code::\n\n conda install --file requirements-dev.txt -c conda-forge\n\nand then, install pylbm\n\n.. code::\n\n pip install .\n\nFor more information about what you can achieve with pylbm, take a look at the documentation\n\n`<http://pylbm.readthedocs.io>`_\n",
"bugtrack_url": null,
"license": null,
"summary": "A flexible Python package for lattice Boltzmann method",
"version": "0.10.0",
"project_urls": {
"Documentation": "https://pylbm.readthedocs.io",
"Source": "https://github.com/pylbm/pylbm"
},
"split_keywords": [
"boltzmann",
" lattice",
" methods"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cfcfd8c279df52224d576a4531b28743a00c0b23a8cfcd2a163de69f0271185e",
"md5": "64da9f3d1fe0edb27f2037c9945338a6",
"sha256": "fa9d21ff63f5a3ec7963b9e7d616433f56e62849b3da47fa94d519c0338388f3"
},
"downloads": -1,
"filename": "pylbm-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64da9f3d1fe0edb27f2037c9945338a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 150714,
"upload_time": "2024-04-07T05:20:40",
"upload_time_iso_8601": "2024-04-07T05:20:40.898444Z",
"url": "https://files.pythonhosted.org/packages/cf/cf/d8c279df52224d576a4531b28743a00c0b23a8cfcd2a163de69f0271185e/pylbm-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c74d36d5edd01f940acea4dc79adbb061b7e45d4a6d12224fbb3ea75d6552c6c",
"md5": "47232ca5783f30084b1a5b4a99cfd73a",
"sha256": "4a3241a654ed6b647216e64866fc3e96a82dbe5676f72a06084194f853787eff"
},
"downloads": -1,
"filename": "pylbm-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "47232ca5783f30084b1a5b4a99cfd73a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 114828,
"upload_time": "2024-04-07T05:20:42",
"upload_time_iso_8601": "2024-04-07T05:20:42.994406Z",
"url": "https://files.pythonhosted.org/packages/c7/4d/36d5edd01f940acea4dc79adbb061b7e45d4a6d12224fbb3ea75d6552c6c/pylbm-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 05:20:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pylbm",
"github_project": "pylbm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pylbm"
}
