navis-fastcore


Namenavis-fastcore JSON
Version 0.0.7 PyPI version JSON
download
home_pageNone
SummaryNAVis core functions reimplemented in Rust.
upload_time2024-09-16 17:01:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![test](https://github.com/schlegelp/fastcore-rs/actions/workflows/test.yml/badge.svg)](https://github.com/schlegelp/fastcore-rs/actions/workflows/test.yml) [![docs](https://github.com/schlegelp/fastcore-rs/actions/workflows/docs.yaml/badge.svg)](https://schlegelp.github.io/fastcore-rs/)

# navis-fastcore

Re-implementation of `navis` core functions in Rust.

## Install

We provide precompiled binaries for all major Python versions, CPU architectures and operating systems.

From [PyPI](https://pypi.org/project/navis-fastcore):

```bash
pip install navis-fastcore
```

If that fails, try building from source (see below).

## Usage

`navis-fastcore` itself does not depend on `navis`. This is to allow
using `fastcore` in libraries other than `navis`. Please see the
[docs](https://schlegelp.github.io/fastcore-rs/) for examples.

`navis` will automatically use `fastcore` if it is available.
The integration is still work in progress, so for now you
should install `navis` from Github to make sure you have the
latest version.

## Building from source

1. [Install rust](https://www.rust-lang.org/tools/install)
2. Clone this repository
3. `cd` into `fastcore-rs/py` directory
4. Create a virtual environment: `python3 -m venv .venv`
5. Activate virtual environment: `source .venv/bin/activate`
6. Compile via either:
   - `maturin develop --release` which will compile the
     extension into the `fastcore/` directory
   - `maturin build --release` to build wheel in `/target/wheels`
7. To install the Python package either do:
  -  `pip install -e .` to install in editable mode
  - `pip install targets/wheels/navis_fastcore....whl`

Note that unless you compiled with the `--release` flag,
timings will be much slower (up to 10x) than in a release build!

## Test
First make sure `pytest` is installed:
```
pip install pytest -U
```

Then run the test-suite like so:
```
pytest --verbose -s
```


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "navis-fastcore",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Philipp Schlegel <pms70@cam.ac.uk>",
    "download_url": "https://files.pythonhosted.org/packages/15/dd/fa02783a0c9f9c7c43b6b3f600290d2ca2df99805cb5ecde3311aa991d88/navis_fastcore-0.0.7.tar.gz",
    "platform": null,
    "description": "[![test](https://github.com/schlegelp/fastcore-rs/actions/workflows/test.yml/badge.svg)](https://github.com/schlegelp/fastcore-rs/actions/workflows/test.yml) [![docs](https://github.com/schlegelp/fastcore-rs/actions/workflows/docs.yaml/badge.svg)](https://schlegelp.github.io/fastcore-rs/)\n\n# navis-fastcore\n\nRe-implementation of `navis` core functions in Rust.\n\n## Install\n\nWe provide precompiled binaries for all major Python versions, CPU architectures and operating systems.\n\nFrom [PyPI](https://pypi.org/project/navis-fastcore):\n\n```bash\npip install navis-fastcore\n```\n\nIf that fails, try building from source (see below).\n\n## Usage\n\n`navis-fastcore` itself does not depend on `navis`. This is to allow\nusing `fastcore` in libraries other than `navis`. Please see the\n[docs](https://schlegelp.github.io/fastcore-rs/) for examples.\n\n`navis` will automatically use `fastcore` if it is available.\nThe integration is still work in progress, so for now you\nshould install `navis` from Github to make sure you have the\nlatest version.\n\n## Building from source\n\n1. [Install rust](https://www.rust-lang.org/tools/install)\n2. Clone this repository\n3. `cd` into `fastcore-rs/py` directory\n4. Create a virtual environment: `python3 -m venv .venv`\n5. Activate virtual environment: `source .venv/bin/activate`\n6. Compile via either:\n   - `maturin develop --release` which will compile the\n     extension into the `fastcore/` directory\n   - `maturin build --release` to build wheel in `/target/wheels`\n7. To install the Python package either do:\n  -  `pip install -e .` to install in editable mode\n  - `pip install targets/wheels/navis_fastcore....whl`\n\nNote that unless you compiled with the `--release` flag,\ntimings will be much slower (up to 10x) than in a release build!\n\n## Test\nFirst make sure `pytest` is installed:\n```\npip install pytest -U\n```\n\nThen run the test-suite like so:\n```\npytest --verbose -s\n```\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "NAVis core functions reimplemented in Rust.",
    "version": "0.0.7",
    "project_urls": {
        "Changelog": "https://github.com/schlegelp/fastcore-rs/blob/master/CHANGELOG.md",
        "Documentation": "https://schlegelp.github.io/fastcore-rs/",
        "Issues": "https://github.com/schlegelp/fastcore-rs/issues",
        "Repository": "https://github.com/schlegelp/fastcore-rs"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f77fb4c2de8ed06090cec2f0bd50e2864d90e97e6e6d5379282a0af6fe4bfbc1",
                "md5": "a43be673f6e51520b9d862b4652469fe",
                "sha256": "a8efbc3226472d0d1b9bcfe41b0e6c381ec1da52f8a1ffae7d714414f55d7ee7"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-macosx_10_12_x86_64.whl",
            "has_sig": false,
            "md5_digest": "a43be673f6e51520b9d862b4652469fe",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 461695,
            "upload_time": "2024-09-16T17:01:30",
            "upload_time_iso_8601": "2024-09-16T17:01:30.234865Z",
            "url": "https://files.pythonhosted.org/packages/f7/7f/b4c2de8ed06090cec2f0bd50e2864d90e97e6e6d5379282a0af6fe4bfbc1/navis_fastcore-0.0.7-cp39-abi3-macosx_10_12_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "542f2dd6d0da4de38b244b3ff08ce9f3bbd6f2767deb7be50b742f58cede9a19",
                "md5": "a89b16d547222ea40812d97642a45831",
                "sha256": "409e93752762cc9524450e2af2b28bec04d717e9c780cb7c21806cd4d6635a13"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-macosx_11_0_arm64.whl",
            "has_sig": false,
            "md5_digest": "a89b16d547222ea40812d97642a45831",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 438116,
            "upload_time": "2024-09-16T17:01:31",
            "upload_time_iso_8601": "2024-09-16T17:01:31.749734Z",
            "url": "https://files.pythonhosted.org/packages/54/2f/2dd6d0da4de38b244b3ff08ce9f3bbd6f2767deb7be50b742f58cede9a19/navis_fastcore-0.0.7-cp39-abi3-macosx_11_0_arm64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "96dfcb3c0f8464bf89a80825db9af73c4d2bd25482761f89fd3dda5598ac7714",
                "md5": "16e82240e3b80d8e89c5217c867fadf0",
                "sha256": "ade9a44251641cc132d098ecbc39b4bb8f90b1fa3f73ce6e404d007f29990577"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-manylinux_2_12_i686.manylinux2010_i686.whl",
            "has_sig": false,
            "md5_digest": "16e82240e3b80d8e89c5217c867fadf0",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 506154,
            "upload_time": "2024-09-16T17:01:33",
            "upload_time_iso_8601": "2024-09-16T17:01:33.144078Z",
            "url": "https://files.pythonhosted.org/packages/96/df/cb3c0f8464bf89a80825db9af73c4d2bd25482761f89fd3dda5598ac7714/navis_fastcore-0.0.7-cp39-abi3-manylinux_2_12_i686.manylinux2010_i686.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7e7d0eb34db1d933a890e2e55497ecfe540cee11e2404c364988e5cb541edd80",
                "md5": "35e27a32a2dd79174a69ac4ae5ff8b12",
                "sha256": "aa9022ae4863efd5b4005e534922bdf2c3b7591761f0fe8f17615b7895fc538f"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
            "has_sig": false,
            "md5_digest": "35e27a32a2dd79174a69ac4ae5ff8b12",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 487973,
            "upload_time": "2024-09-16T17:01:35",
            "upload_time_iso_8601": "2024-09-16T17:01:35.041340Z",
            "url": "https://files.pythonhosted.org/packages/7e/7d/0eb34db1d933a890e2e55497ecfe540cee11e2404c364988e5cb541edd80/navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "72c6605aae399cc38153248408de6fa402ac1312ad999231ec922b7dac60ab7e",
                "md5": "c17561debd2f0af6fc298ca2a935cb60",
                "sha256": "70f9369ced300927bece7dd345bece50fd86b27cef5bf5ad19eb0f9c7a8e3e0a"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
            "has_sig": false,
            "md5_digest": "c17561debd2f0af6fc298ca2a935cb60",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 507006,
            "upload_time": "2024-09-16T17:01:36",
            "upload_time_iso_8601": "2024-09-16T17:01:36.260352Z",
            "url": "https://files.pythonhosted.org/packages/72/c6/605aae399cc38153248408de6fa402ac1312ad999231ec922b7dac60ab7e/navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "23f190cc963315903981971c020c061e50da4a3d970be59bffc65b4c0ee45139",
                "md5": "69e85fa1e1b887efa19ecb6e7fb82ee2",
                "sha256": "580c918c0878dfd4d786cf817d83670122c8f0a4e91edcec84aaa452d24ace2d"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
            "has_sig": false,
            "md5_digest": "69e85fa1e1b887efa19ecb6e7fb82ee2",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 540260,
            "upload_time": "2024-09-16T17:01:38",
            "upload_time_iso_8601": "2024-09-16T17:01:38.205991Z",
            "url": "https://files.pythonhosted.org/packages/23/f1/90cc963315903981971c020c061e50da4a3d970be59bffc65b4c0ee45139/navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "235f2ca79303d1fc482a7599cbb3fe7cbcc12f8c9575f546308b9816b0c6acc6",
                "md5": "8a9cd64237223e6c58a6cb2050698d83",
                "sha256": "19e75656f2e0c512f8ec0557cfbd8f4596b94d4bf0854170bcc8f50dd4205e28"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl",
            "has_sig": false,
            "md5_digest": "8a9cd64237223e6c58a6cb2050698d83",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 697271,
            "upload_time": "2024-09-16T17:01:39",
            "upload_time_iso_8601": "2024-09-16T17:01:39.857031Z",
            "url": "https://files.pythonhosted.org/packages/23/5f/2ca79303d1fc482a7599cbb3fe7cbcc12f8c9575f546308b9816b0c6acc6/navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e9c2759d0570f3941db8d549174cd1d0d0ad5d4dea53d57bea88f94df9752099",
                "md5": "a519a72ddf589c6fe369b7c97afd4a8f",
                "sha256": "c1abf1ec4529012178eaad16bc3a7764c8880cda72ed64cc1bba2c58b8e30c91"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "a519a72ddf589c6fe369b7c97afd4a8f",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 491778,
            "upload_time": "2024-09-16T17:01:41",
            "upload_time_iso_8601": "2024-09-16T17:01:41.453932Z",
            "url": "https://files.pythonhosted.org/packages/e9/c2/759d0570f3941db8d549174cd1d0d0ad5d4dea53d57bea88f94df9752099/navis_fastcore-0.0.7-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9742641ef550e4f35185ce3cd913c04b3e8ab6705ca572a4a39e41ad6d496455",
                "md5": "4927b22780d1d4fc6f7c6c2bce3b706b",
                "sha256": "6d7108a48a298145c6860ee0f0ed415b707db27eaec97588823b11997e41e0d2"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-win32.whl",
            "has_sig": false,
            "md5_digest": "4927b22780d1d4fc6f7c6c2bce3b706b",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 347273,
            "upload_time": "2024-09-16T17:01:42",
            "upload_time_iso_8601": "2024-09-16T17:01:42.739729Z",
            "url": "https://files.pythonhosted.org/packages/97/42/641ef550e4f35185ce3cd913c04b3e8ab6705ca572a4a39e41ad6d496455/navis_fastcore-0.0.7-cp39-abi3-win32.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a9f510580c5543b52d9f1da7c29f60dee4440644a679457add3f49dacf971a3d",
                "md5": "59bd34a2690ea2da58309fb7c2a7f7d6",
                "sha256": "76094b7dc4afb8a0014309e5126b9bc0ec12c7682b6533cb5501bb92e155599d"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7-cp39-abi3-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "59bd34a2690ea2da58309fb7c2a7f7d6",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 371380,
            "upload_time": "2024-09-16T17:01:43",
            "upload_time_iso_8601": "2024-09-16T17:01:43.994380Z",
            "url": "https://files.pythonhosted.org/packages/a9/f5/10580c5543b52d9f1da7c29f60dee4440644a679457add3f49dacf971a3d/navis_fastcore-0.0.7-cp39-abi3-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "15ddfa02783a0c9f9c7c43b6b3f600290d2ca2df99805cb5ecde3311aa991d88",
                "md5": "8f5907b06861620f26aed53a561b8e9b",
                "sha256": "2eef5c655318b99597e898105d90f7903d0fb05d86e862914252574f14c62a39"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "8f5907b06861620f26aed53a561b8e9b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 761412,
            "upload_time": "2024-09-16T17:01:45",
            "upload_time_iso_8601": "2024-09-16T17:01:45.596309Z",
            "url": "https://files.pythonhosted.org/packages/15/dd/fa02783a0c9f9c7c43b6b3f600290d2ca2df99805cb5ecde3311aa991d88/navis_fastcore-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-16 17:01:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "schlegelp",
    "github_project": "fastcore-rs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "navis-fastcore"
}
        
Elapsed time: 0.30964s