nlcpy


Namenlcpy JSON
Version 3.0.1 PyPI version JSON
download
home_pagehttps://github.com/SX-Aurora/nlcpy/
SummaryNLCPy is a package for accelerating performance of Python scripts using NumPy on SX-Aurora TSUBASA.
upload_time2023-09-27 07:26:28
maintainer
docs_urlNone
authorNEC
requires_python<3.9,>=3.6
licenseBSD 3-Clause
keywords nlcpy
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            ![NLCPy_banner](https://github.com/SX-Aurora/nlcpy/blob/master/banner/NLCPy_banner.png?raw=true)

# NLCPy : NumPy-like API accelerated with SX-Aurora TSUBASA

[![GitHub license](https://img.shields.io/github/license/SX-Aurora/nlcpy)](https://github.com/SX-Aurora/nlcpy/blob/master/LICENSE)
[![Downloads](https://pepy.tech/badge/nlcpy)](https://pepy.tech/project/nlcpy)
[![Python Versions](https://img.shields.io/pypi/pyversions/nlcpy.svg)](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",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<3.9,>=3.6",
    "maintainer_email": "",
    "keywords": "nlcpy",
    "author": "NEC",
    "author_email": "dev-nlcpy@sxarr.jp.nec.com",
    "download_url": "",
    "platform": null,
    "description": "![NLCPy_banner](https://github.com/SX-Aurora/nlcpy/blob/master/banner/NLCPy_banner.png?raw=true)\n\n# NLCPy : NumPy-like API accelerated with SX-Aurora TSUBASA\n\n[![GitHub license](https://img.shields.io/github/license/SX-Aurora/nlcpy)](https://github.com/SX-Aurora/nlcpy/blob/master/LICENSE)\n[![Downloads](https://pepy.tech/badge/nlcpy)](https://pepy.tech/project/nlcpy)\n[![Python Versions](https://img.shields.io/pypi/pyversions/nlcpy.svg)](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\n\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause",
    "summary": "NLCPy is a package for accelerating performance of Python scripts using NumPy on SX-Aurora TSUBASA.",
    "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"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "82659b50a270340aabf2506bb2f2e1d2fc63db0fdbe85c972e2c05d757f6d42f",
                "md5": "b08db49388ee463a5a2bf762e6a68463",
                "sha256": "a8c58c55e2e3ef191a02db0de13dcab7f241e02b143ebae3cdc9fa8cb33b969f"
            },
            "downloads": -1,
            "filename": "nlcpy-3.0.1-cp36-cp36m-manylinux1_x86_64.whl",
            "has_sig": false,
            "md5_digest": "b08db49388ee463a5a2bf762e6a68463",
            "packagetype": "bdist_wheel",
            "python_version": "cp36",
            "requires_python": "<3.9,>=3.6",
            "size": 10996734,
            "upload_time": "2023-09-27T07:26:28",
            "upload_time_iso_8601": "2023-09-27T07:26:28.774501Z",
            "url": "https://files.pythonhosted.org/packages/82/65/9b50a270340aabf2506bb2f2e1d2fc63db0fdbe85c972e2c05d757f6d42f/nlcpy-3.0.1-cp36-cp36m-manylinux1_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "839a2b11e355add64b62f151596d0e393254627efaec0c5eb5c59c9047407589",
                "md5": "9d1da7d9ad3a628b7d1e48a8bb57f310",
                "sha256": "d89592c518365d1d541cfbaa249e96d2af5ad026bf075b0229ae25b05ffcac68"
            },
            "downloads": -1,
            "filename": "nlcpy-3.0.1-cp37-cp37m-manylinux1_x86_64.whl",
            "has_sig": false,
            "md5_digest": "9d1da7d9ad3a628b7d1e48a8bb57f310",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": "<3.9,>=3.6",
            "size": 12116470,
            "upload_time": "2023-09-27T07:28:17",
            "upload_time_iso_8601": "2023-09-27T07:28:17.483315Z",
            "url": "https://files.pythonhosted.org/packages/83/9a/2b11e355add64b62f151596d0e393254627efaec0c5eb5c59c9047407589/nlcpy-3.0.1-cp37-cp37m-manylinux1_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f2a52b0abb7f909556d81a6af832012ca02832279eab9c70f4bc6239f5a47052",
                "md5": "f4c9f19e988ae1e1b1b57976dc495fdb",
                "sha256": "c825bf42c33f02df483485c95cf7b57f1c62303b40d414a4710c634697fb09bc"
            },
            "downloads": -1,
            "filename": "nlcpy-3.0.1-cp38-cp38-manylinux1_x86_64.whl",
            "has_sig": false,
            "md5_digest": "f4c9f19e988ae1e1b1b57976dc495fdb",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": "<3.9,>=3.6",
            "size": 13166987,
            "upload_time": "2023-09-27T07:30:25",
            "upload_time_iso_8601": "2023-09-27T07:30:25.296125Z",
            "url": "https://files.pythonhosted.org/packages/f2/a5/2b0abb7f909556d81a6af832012ca02832279eab9c70f4bc6239f5a47052/nlcpy-3.0.1-cp38-cp38-manylinux1_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-27 07:26:28",
    "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"
}
        
NEC
Elapsed time: 0.14176s