# NLCPy : NumPy-like API accelerated with SX-Aurora TSUBASA
[](https://github.com/SX-Aurora/nlcpy/blob/master/LICENSE)
[](https://pepy.tech/project/nlcpy)
[](https://pypi.org/project/nlcpy/)
`NLCPy` is a library for accelerating performance of Python scripts using `NumPy` on SX-Aurora TSUBASA. Python programmers can use this library on Linux/x86 of SX-Aurora TSUBASA. NLCPy's API is designed based on NumPy's one. The current version provides a subset of NumPy's API.
## Requirements
Before the installation, the following components are required to be installed on your x86 Node of SX-Aurora TSUBASA.
- [NEC SDK](https://sxauroratsubasa.sakura.ne.jp/documents/guide/pdfs/InstallationGuide_E.pdf)
- required NEC C/C++ compiler version: >= 5.0.0
- required NLC version: >= 3.0.0
- [Alternative VE Offloading (AVEO)](https://sxauroratsubasa.sakura.ne.jp/documents/veos/en/aveo/index.html)
- required version: >= 3.0.2
- If you install NLCPy from wheel, the runtime packages of Alternative VE Offloading(AVEO) are required.
```
# yum install veoffload-aveo veoffload-aveorun-ve1 veoffload-aveorun-ve3
```
- If you install NLCPy from source, the development packages of Alternative VE Offloading(AVEO) are required.
```
# yum install veoffload-aveo-devel veoffload-aveorun-ve1-devel veoffload-aveorun-ve3-devel
```
- veosinfo3
```
# yum install veosinfo3
```
- [Python](https://www.python.org/)
- required version: 3.6, 3.7, or 3.8
- [NumPy](https://www.numpy.org/)
- required version: >= v1.17
## Install from wheel
You can install NLCPy by executing either of following commands.
- Install from PyPI
```
$ pip install nlcpy
```
- Install from your local computer
1. Download [the wheel package](https://github.com/SX-Aurora/nlcpy/releases) from GitHub.
2. Put the wheel package to your any directory.
3. Install the local wheel package via pip command.
```
$ pip install <path_to_wheel>
```
The shared objects for Vector Engine, which are included in the wheel package, are tested by using NEC C/C++ Compiler Version 5.0.0 and NumPy v1.19.5.
## Install from source (with building)
Before building source files, please install following packages.
```
$ pip install numpy cython wheel
$ sudo yum install veosinfo3-devel
$ sudo yum install veoffload-aveo-devel veoffload-aveorun-ve1-devel veoffload-aveorun-ve3-devel
```
And, entering these commands in the environment where `gcc` and `ncc` commands are available.
```
$ git clone https://github.com/SX-Aurora/nlcpy.git
$ cd nlcpy
$ python3 setup.py build_ext --targ ve1,ve3,vh
$ python3 setup.py intall --targ ve1,ve3,vh
```
## Documentation
- [NLCPy User's Guide](https://sxauroratsubasa.sakura.ne.jp/documents/nlcpy/en/index.html)
## License
The BSD-3-Clause license (see `LICENSE` file).
NLCPy is derived from NumPy, CuPy, PyVEO, and numpydoc (see `LICENSE_DETAIL/LICENSE_DETAIL` file).
Raw data
{
"_id": null,
"home_page": "https://github.com/SX-Aurora/nlcpy/",
"name": "nlcpy-ve1-kernel",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.9,>=3.6",
"maintainer_email": "",
"keywords": "nlcpy_ve1_kernel",
"author": "NEC",
"author_email": "dev-nlcpy@sxarr.jp.nec.com",
"download_url": "",
"platform": null,
"description": "\n\n# NLCPy : NumPy-like API accelerated with SX-Aurora TSUBASA\n\n[](https://github.com/SX-Aurora/nlcpy/blob/master/LICENSE)\n[](https://pepy.tech/project/nlcpy)\n[](https://pypi.org/project/nlcpy/)\n\n\n`NLCPy` is a library for accelerating performance of Python scripts using `NumPy` on SX-Aurora TSUBASA. Python programmers can use this library on Linux/x86 of SX-Aurora TSUBASA. NLCPy's API is designed based on NumPy's one. The current version provides a subset of NumPy's API.\n\n## Requirements\n\nBefore the installation, the following components are required to be installed on your x86 Node of SX-Aurora TSUBASA.\n\n- [NEC SDK](https://sxauroratsubasa.sakura.ne.jp/documents/guide/pdfs/InstallationGuide_E.pdf)\n\t- required NEC C/C++ compiler version: >= 5.0.0\n\t- required NLC version: >= 3.0.0\n\n- [Alternative VE Offloading (AVEO)](https://sxauroratsubasa.sakura.ne.jp/documents/veos/en/aveo/index.html)\n\n - required version: >= 3.0.2\n\t- If you install NLCPy from wheel, the runtime packages of Alternative VE Offloading(AVEO) are required.\n\n ```\n # yum install veoffload-aveo veoffload-aveorun-ve1 veoffload-aveorun-ve3\n ```\n\n\t- If you install NLCPy from source, the development packages of Alternative VE Offloading(AVEO) are required.\n\n ```\n # yum install veoffload-aveo-devel veoffload-aveorun-ve1-devel veoffload-aveorun-ve3-devel\n ```\n\n- veosinfo3\n\n ```\n # yum install veosinfo3\n ```\n\n- [Python](https://www.python.org/)\n - required version: 3.6, 3.7, or 3.8\n\n- [NumPy](https://www.numpy.org/)\n - required version: >= v1.17\n\n## Install from wheel\n\nYou can install NLCPy by executing either of following commands.\n\n- Install from PyPI\n\n ```\n $ pip install nlcpy\n ```\n\n- Install from your local computer\n\n 1. Download [the wheel package](https://github.com/SX-Aurora/nlcpy/releases) from GitHub.\n\n 2. Put the wheel package to your any directory.\n\n 3. Install the local wheel package via pip command.\n\n ```\n $ pip install <path_to_wheel>\n ```\n\nThe shared objects for Vector Engine, which are included in the wheel package, are tested by using NEC C/C++ Compiler Version 5.0.0 and NumPy v1.19.5.\n\n## Install from source (with building)\n\nBefore building source files, please install following packages.\n\n```\n$ pip install numpy cython wheel\n$ sudo yum install veosinfo3-devel\n$ sudo yum install veoffload-aveo-devel veoffload-aveorun-ve1-devel veoffload-aveorun-ve3-devel\n```\n\nAnd, entering these commands in the environment where `gcc` and `ncc` commands are available.\n\n```\n$ git clone https://github.com/SX-Aurora/nlcpy.git\n$ cd nlcpy\n$ python3 setup.py build_ext --targ ve1,ve3,vh\n$ python3 setup.py intall --targ ve1,ve3,vh\n```\n\n## Documentation\n- [NLCPy User's Guide](https://sxauroratsubasa.sakura.ne.jp/documents/nlcpy/en/index.html)\n\n## License\n\nThe BSD-3-Clause license (see `LICENSE` file).\n\nNLCPy is derived from NumPy, CuPy, PyVEO, and numpydoc (see `LICENSE_DETAIL/LICENSE_DETAIL` file).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "VE1 kernel for NLCPy",
"version": "3.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/SX-Aurora/nlcpy/issues",
"Documentation": "https://www.hpc.nec/documents/nlcpy/en/index.html",
"Homepage": "https://github.com/SX-Aurora/nlcpy/"
},
"split_keywords": [
"nlcpy_ve1_kernel"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4555245566c1b7893212773086334308da866b2d7049903b866b861295b532be",
"md5": "0ee235a820418baa06c27139b3fe4302",
"sha256": "3e99d52c5819844bd12b880ab20bdce1844dca5f6f9e3dc3cb57c02d1933b1ce"
},
"downloads": -1,
"filename": "nlcpy_ve1_kernel-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ee235a820418baa06c27139b3fe4302",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.9,>=3.6",
"size": 90204918,
"upload_time": "2023-09-27T07:22:40",
"upload_time_iso_8601": "2023-09-27T07:22:40.784926Z",
"url": "https://files.pythonhosted.org/packages/45/55/245566c1b7893212773086334308da866b2d7049903b866b861295b532be/nlcpy_ve1_kernel-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 07:22:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SX-Aurora",
"github_project": "nlcpy",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"tox": true,
"lcname": "nlcpy-ve1-kernel"
}
JSON
