# lcodePy
## Overview
LCODE is a free software for numerical simulation of
particle beam-driven plasma wakefield acceleration.
LCODE is based on the quasistatic approximation, capable
of simulation in 2D and 3D geometry, and can use GPUs and CPUs.
For now, this under active development. This is
a complete overhaul of the old C version in Python.
- **Website:** https://lcode.info
- **Documentation:** https://lcode.info/docs
## Instalation
We use [Anaconda](https://www.continuum.io/why-anaconda) and we recommend
installing lcode in a separate environment.
Any other python installation should work fine, but has not been tested.
- Create a new environment and install the dependencies:
```
conda create -n lcode-env -c conda-forge numba numpy scipy matplotlib mpi4py
```
or
```
conda env create -f conda-env.yml
```
where `conda-env.yml` is avalible in sources.
- Acivate the new environment:
```
conda activate lcode-env
```
- **Optional**: in order to run simulations on GPU, add cupy and other necessary packages to the line of dependencies when creating a new eviroment. Check in advance if you have the drivers for your GPU installed. It is not necessary to install CUDA Toolkit in advance. For any other questions about cupy, please check https://docs.cupy.dev/en/stable/install.html
```
conda create -n lcode-env -c conda-forge numba numpy scipy matplotlib cupy
```
- Install lcode:
```
pip install lcode
```
or download sources from GitHub and run the forlowing command
in downloaded directory:
```
pip install .
```
----------
You can also find a more mature 2D version of LCODE at
http://lcode.info/.
Fill free to contact `team@lcode.info` for assistance with it.
Raw data
{
"_id": null,
"home_page": "https://lcode.info",
"name": "lcode",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "plasma wakefield acceleration, quasistatic approximation, numerical simulation",
"author": "lcodePy-team",
"author_email": "team@lcode.info",
"download_url": "https://files.pythonhosted.org/packages/bb/41/66a5189b43a552f36036ca099a2ba77fd9c56beb669d53faf1b503a39170/lcode-0.3.1.tar.gz",
"platform": null,
"description": "# lcodePy\n\n## Overview \n\nLCODE is a free software for numerical simulation of\nparticle beam-driven plasma wakefield acceleration.\nLCODE is based on the quasistatic approximation, capable\nof simulation in 2D and 3D geometry, and can use GPUs and CPUs.\n\nFor now, this under active development. This is\na complete overhaul of the old C version in Python.\n\n- **Website:** https://lcode.info\n- **Documentation:** https://lcode.info/docs\n\n## Instalation \n\nWe use [Anaconda](https://www.continuum.io/why-anaconda) and we recommend \ninstalling lcode in a separate environment. \nAny other python installation should work fine, but has not been tested. \n\n\n- Create a new environment and install the dependencies:\n```\nconda create -n lcode-env -c conda-forge numba numpy scipy matplotlib mpi4py\n```\nor \n```\nconda env create -f conda-env.yml \n```\nwhere `conda-env.yml` is avalible in sources.\n\n- Acivate the new environment:\n```\nconda activate lcode-env\n```\n\n- **Optional**: in order to run simulations on GPU, add cupy and other necessary packages to the line of dependencies when creating a new eviroment. Check in advance if you have the drivers for your GPU installed. It is not necessary to install CUDA Toolkit in advance. For any other questions about cupy, please check https://docs.cupy.dev/en/stable/install.html\n```\nconda create -n lcode-env -c conda-forge numba numpy scipy matplotlib cupy\n```\n\n- Install lcode:\n```\npip install lcode\n```\nor download sources from GitHub and run the forlowing command\nin downloaded directory:\n```\npip install .\n```\n\n\n----------\n\nYou can also find a more mature 2D version of LCODE at\nhttp://lcode.info/.\n\nFill free to contact `team@lcode.info` for assistance with it.\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause-extended",
"summary": "LCODE is a free software for simulationplasma wakefield acceleration based on QSA.",
"version": "0.3.1",
"project_urls": {
"Download": "https://github.com/lcodePy-team/lcodePy",
"Homepage": "https://lcode.info"
},
"split_keywords": [
"plasma wakefield acceleration",
" quasistatic approximation",
" numerical simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e6667f982b078948298dcf7380bab3362be0e446dd4cd4fe17da1c5123c08d93",
"md5": "92f5c61c3f2e6802d95c122d7c1169f3",
"sha256": "f9edaba77d272a2aa621c9dcbb891733fc1158bd083b10d55f1d072dea8617e6"
},
"downloads": -1,
"filename": "lcode-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92f5c61c3f2e6802d95c122d7c1169f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 105374,
"upload_time": "2024-05-24T16:18:44",
"upload_time_iso_8601": "2024-05-24T16:18:44.831482Z",
"url": "https://files.pythonhosted.org/packages/e6/66/7f982b078948298dcf7380bab3362be0e446dd4cd4fe17da1c5123c08d93/lcode-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb4166a5189b43a552f36036ca099a2ba77fd9c56beb669d53faf1b503a39170",
"md5": "063ee1a79946bcc90fde38f16c2affcf",
"sha256": "c068d44b54c562147ada55c539e2ec6a1b26a8d4224615f733b4279ca78d5b28"
},
"downloads": -1,
"filename": "lcode-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "063ee1a79946bcc90fde38f16c2affcf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 84257,
"upload_time": "2024-05-24T16:18:46",
"upload_time_iso_8601": "2024-05-24T16:18:46.476895Z",
"url": "https://files.pythonhosted.org/packages/bb/41/66a5189b43a552f36036ca099a2ba77fd9c56beb669d53faf1b503a39170/lcode-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-24 16:18:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lcodePy-team",
"github_project": "lcodePy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "lcode"
}
JSON
