| Name | pyccel JSON |
| Version |
1.12.1
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-10-01 15:49:11 |
| maintainer | None |
| docs_url | None |
| author | Pyccel development team |
| requires_python | >=3.8 |
| license | None |
| keywords |
math
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Pyccel : write Python code, get Fortran speed
[](https://github.com/pyccel/pyccel/actions/workflows/linux.yml) [](https://github.com/pyccel/pyccel/actions/workflows/macosx.yml) [](https://github.com/pyccel/pyccel/actions/workflows/windows.yml) [](https://github.com/pyccel/pyccel/actions/workflows/anaconda_linux.yml) [](https://github.com/pyccel/pyccel/actions/workflows/anaconda_windows.yml) [](https://github.com/pyccel/pyccel/actions/workflows/intel.yml) [](https://www.codacy.com/gh/pyccel/pyccel?utm_source=github.com&utm_medium=referral&utm_content=pyccel/pyccel&utm_campaign=Badge_Grade) [](https://doi.org/10.21105/joss.04991)
**Pyccel** stands for Python extension language using accelerators.
The aim of **Pyccel** is to provide a simple way to generate automatically, parallel low level code. The main uses would be:
1. Convert a _Python_ code (or project) into a Fortran or C code.
2. Accelerate _Python_ functions by converting them to _Fortran_ or _C_ functions.
**Pyccel** can be viewed as:
- _Python-to-Fortran/C_ converter
- a compiler for a _Domain Specific Language_ with _Python_ syntax
Pyccel comes with a selection of **extensions** allowing you to convert calls to some specific Python packages to Fortran/C. The following packages will be (partially) covered:
- `numpy`
- `scipy`
Pyccel's acceleration capabilities lead to much faster code. Comparisons of Python vs Pyccel or other tools can be found in the [benchmarks](https://github.com/pyccel/pyccel-benchmarks) repository.
The results for the `devel` branch currently show the following performance on Python 3.10:
If you are eager to try Pyccel out, we recommend reading our [quick-start guide](https://github.com/pyccel/pyccel/blob/devel/docs/quickstart.md).
## Citing Pyccel
If Pyccel has been significant in your research, and you would like to acknowledge the project in your academic publication, we would ask that you cite the following paper:
Bourne, Güçlü, Hadjout and Ratnani (2023). Pyccel: a Python-to-X transpiler for scientific high-performance computing. Journal of Open Source Software, 8(83), 4991, https://doi.org/10.21105/joss.04991
The associated bibtex can be found [here](https://github.com/pyccel/pyccel/blob/devel/pyccel.bib).
## Installation
Pyccel has a few system requirements to ensure that the system where it is installed is capable of compiling Fortran code.
These requirements are detailed in the [documentation](https://github.com/pyccel/pyccel/blob/devel/docs/installation.md).
Once all requirements are satisfied, the simplest way to install Pyccel is using PyPI.
Simply run:
```sh
python3 -m pip install --user pyccel
```
Alternative installation methods such as installing from source, or installing with a docker are described in the [documentation](https://github.com/pyccel/pyccel/blob/devel/docs/installation.md).
## Contributing
We welcome any and all contributions.
There are many ways to help with the Pyccel project which are more or less involved.
A summary can be found in the [documentation](https://github.com/pyccel/pyccel/blob/devel/docs/CONTRIBUTING.md).
We can also be contacted via the [Pyccel Discord Server](https://discord.gg/2Q6hwjfFVb).
## User Documentation
- [Quick-start Guide](https://github.com/pyccel/pyccel/blob/devel/docs/quickstart.md)
- [Installation](https://github.com/pyccel/pyccel/blob/devel/docs/installation.md)
- [Contributing](https://github.com/pyccel/pyccel/blob/devel/docs/CONTRIBUTING.md)
- [C/Fortran Compilers](https://github.com/pyccel/pyccel/blob/devel/docs/compiler.md)
- [Decorators](https://github.com/pyccel/pyccel/blob/devel/docs/decorators.md)
- [Header Files](https://github.com/pyccel/pyccel/blob/devel/docs/header-files.md)
- [Templates](https://github.com/pyccel/pyccel/blob/devel/docs/templates.md)
- [N-dimensional Arrays](https://github.com/pyccel/pyccel/blob/devel/docs/ndarrays.md)
- [Function-pointers as arguments](https://github.com/pyccel/pyccel/blob/devel/docs/function-pointers-as-arguments.md)
- [Const keyword](https://github.com/pyccel/pyccel/blob/devel/docs/const_keyword.md)
- Supported libraries/APIs
- [OpenMP](https://github.com/pyccel/pyccel/blob/devel/docs/openmp.md)
- [NumPy](https://github.com/pyccel/pyccel/blob/devel/docs/numpy-functions.md)
## Developer Documentation
- [Overview](https://github.com/pyccel/pyccel/blob/devel/developer_docs/overview.md)
- [How to solve an issue](https://github.com/pyccel/pyccel/blob/devel/developer_docs/how_to_solve_an_issue.md)
- [Review Process](https://github.com/pyccel/pyccel/blob/devel/developer_docs/review_process.md)
- [Development Conventions](https://github.com/pyccel/pyccel/blob/devel/developer_docs/development_conventions.md)
- [Tips and Tricks](https://github.com/pyccel/pyccel/blob/devel/developer_docs/tips_and_tricks.md)
- [Scope](https://github.com/pyccel/pyccel/blob/devel/developer_docs/scope.md)
- [Type Inference](https://github.com/pyccel/pyccel/blob/devel/developer_docs/type_inference.md)
- [Array Ordering](https://github.com/pyccel/pyccel/blob/devel/developer_docs/order_docs.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "pyccel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "math",
"author": "Pyccel development team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ad/76/dbc2e8aefab51927da9284b27e0b127e1bb0450caf8d6d40e258b42af9fe/pyccel-1.12.1.tar.gz",
"platform": null,
"description": "# Pyccel : write Python code, get Fortran speed\n\n [](https://github.com/pyccel/pyccel/actions/workflows/linux.yml) [](https://github.com/pyccel/pyccel/actions/workflows/macosx.yml) [](https://github.com/pyccel/pyccel/actions/workflows/windows.yml) [](https://github.com/pyccel/pyccel/actions/workflows/anaconda_linux.yml) [](https://github.com/pyccel/pyccel/actions/workflows/anaconda_windows.yml) [](https://github.com/pyccel/pyccel/actions/workflows/intel.yml) [](https://www.codacy.com/gh/pyccel/pyccel?utm_source=github.com&utm_medium=referral&utm_content=pyccel/pyccel&utm_campaign=Badge_Grade) [](https://doi.org/10.21105/joss.04991)\n\n**Pyccel** stands for Python extension language using accelerators.\n\nThe aim of **Pyccel** is to provide a simple way to generate automatically, parallel low level code. The main uses would be:\n\n1. Convert a _Python_ code (or project) into a Fortran or C code.\n2. Accelerate _Python_ functions by converting them to _Fortran_ or _C_ functions.\n\n**Pyccel** can be viewed as:\n\n- _Python-to-Fortran/C_ converter\n- a compiler for a _Domain Specific Language_ with _Python_ syntax\n\nPyccel comes with a selection of **extensions** allowing you to convert calls to some specific Python packages to Fortran/C. The following packages will be (partially) covered:\n\n- `numpy`\n- `scipy`\n\nPyccel's acceleration capabilities lead to much faster code. Comparisons of Python vs Pyccel or other tools can be found in the [benchmarks](https://github.com/pyccel/pyccel-benchmarks) repository.\nThe results for the `devel` branch currently show the following performance on Python 3.10:\n\n\nIf you are eager to try Pyccel out, we recommend reading our [quick-start guide](https://github.com/pyccel/pyccel/blob/devel/docs/quickstart.md).\n\n## Citing Pyccel\n\nIf Pyccel has been significant in your research, and you would like to acknowledge the project in your academic publication, we would ask that you cite the following paper:\n\nBourne, G\u00fc\u00e7l\u00fc, Hadjout and Ratnani (2023). Pyccel: a Python-to-X transpiler for scientific high-performance computing. Journal of Open Source Software, 8(83), 4991, https://doi.org/10.21105/joss.04991\n\nThe associated bibtex can be found [here](https://github.com/pyccel/pyccel/blob/devel/pyccel.bib).\n\n## Installation\n\nPyccel has a few system requirements to ensure that the system where it is installed is capable of compiling Fortran code.\nThese requirements are detailed in the [documentation](https://github.com/pyccel/pyccel/blob/devel/docs/installation.md).\nOnce all requirements are satisfied, the simplest way to install Pyccel is using PyPI.\nSimply run:\n\n```sh\npython3 -m pip install --user pyccel\n```\n\nAlternative installation methods such as installing from source, or installing with a docker are described in the [documentation](https://github.com/pyccel/pyccel/blob/devel/docs/installation.md).\n\n## Contributing\n\nWe welcome any and all contributions.\n\nThere are many ways to help with the Pyccel project which are more or less involved.\nA summary can be found in the [documentation](https://github.com/pyccel/pyccel/blob/devel/docs/CONTRIBUTING.md).\n\nWe can also be contacted via the [Pyccel Discord Server](https://discord.gg/2Q6hwjfFVb).\n\n## User Documentation\n\n- [Quick-start Guide](https://github.com/pyccel/pyccel/blob/devel/docs/quickstart.md)\n\n- [Installation](https://github.com/pyccel/pyccel/blob/devel/docs/installation.md)\n\n- [Contributing](https://github.com/pyccel/pyccel/blob/devel/docs/CONTRIBUTING.md)\n\n- [C/Fortran Compilers](https://github.com/pyccel/pyccel/blob/devel/docs/compiler.md)\n\n- [Decorators](https://github.com/pyccel/pyccel/blob/devel/docs/decorators.md)\n\n- [Header Files](https://github.com/pyccel/pyccel/blob/devel/docs/header-files.md)\n\n- [Templates](https://github.com/pyccel/pyccel/blob/devel/docs/templates.md)\n\n- [N-dimensional Arrays](https://github.com/pyccel/pyccel/blob/devel/docs/ndarrays.md)\n\n- [Function-pointers as arguments](https://github.com/pyccel/pyccel/blob/devel/docs/function-pointers-as-arguments.md)\n\n- [Const keyword](https://github.com/pyccel/pyccel/blob/devel/docs/const_keyword.md)\n\n- Supported libraries/APIs\n - [OpenMP](https://github.com/pyccel/pyccel/blob/devel/docs/openmp.md)\n - [NumPy](https://github.com/pyccel/pyccel/blob/devel/docs/numpy-functions.md)\n\n## Developer Documentation\n\n- [Overview](https://github.com/pyccel/pyccel/blob/devel/developer_docs/overview.md)\n- [How to solve an issue](https://github.com/pyccel/pyccel/blob/devel/developer_docs/how_to_solve_an_issue.md)\n- [Review Process](https://github.com/pyccel/pyccel/blob/devel/developer_docs/review_process.md)\n- [Development Conventions](https://github.com/pyccel/pyccel/blob/devel/developer_docs/development_conventions.md)\n- [Tips and Tricks](https://github.com/pyccel/pyccel/blob/devel/developer_docs/tips_and_tricks.md)\n- [Scope](https://github.com/pyccel/pyccel/blob/devel/developer_docs/scope.md)\n- [Type Inference](https://github.com/pyccel/pyccel/blob/devel/developer_docs/type_inference.md)\n- [Array Ordering](https://github.com/pyccel/pyccel/blob/devel/developer_docs/order_docs.md)\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "1.12.1",
"project_urls": {
"Homepage": "https://github.com/pyccel/pyccel"
},
"split_keywords": [
"math"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05aa4d0f9e2f469a86e12a42a3eedbe792cabf56fee927d863132b94272b9525",
"md5": "22f7a4e7696e182fdeb801b0f02650a2",
"sha256": "44b6d6969ac4d4b3bb97e084d77b798a7750ef119cc9d6eee18d53bf3ca6b3d8"
},
"downloads": -1,
"filename": "pyccel-1.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22f7a4e7696e182fdeb801b0f02650a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 500460,
"upload_time": "2024-10-01T15:49:10",
"upload_time_iso_8601": "2024-10-01T15:49:10.470385Z",
"url": "https://files.pythonhosted.org/packages/05/aa/4d0f9e2f469a86e12a42a3eedbe792cabf56fee927d863132b94272b9525/pyccel-1.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad76dbc2e8aefab51927da9284b27e0b127e1bb0450caf8d6d40e258b42af9fe",
"md5": "15900d65b8b4194c409c12a911696156",
"sha256": "d8104234d54df22e93e61cd2c48f59e43f08706c9b2a72ea881ad50b5d0ec9d5"
},
"downloads": -1,
"filename": "pyccel-1.12.1.tar.gz",
"has_sig": false,
"md5_digest": "15900d65b8b4194c409c12a911696156",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 663942,
"upload_time": "2024-10-01T15:49:11",
"upload_time_iso_8601": "2024-10-01T15:49:11.993994Z",
"url": "https://files.pythonhosted.org/packages/ad/76/dbc2e8aefab51927da9284b27e0b127e1bb0450caf8d6d40e258b42af9fe/pyccel-1.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 15:49:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyccel",
"github_project": "pyccel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyccel"
}
