navis-fastcore


Namenavis-fastcore JSON
Version 0.0.9 PyPI version JSON
download
home_pageNone
SummaryNAVis core functions reimplemented in Rust.
upload_time2025-02-06 21:28:40
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/ad/6c/b198e1fb0457b3bfd4e00dd141ae6b10ee0369dbca9bea0ee261e12273ba/navis_fastcore-0.0.9.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.9",
    "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": "730d2eca10c1147473d41770323e685baedb0746f9c3eba9fcae8071c84d37a3",
                "md5": "4cadfee2ef3b771b6bf4a461a9ff8770",
                "sha256": "7e9ea5a263069978bdab45c29e0494863f9ef67a54aa022a5e0ea0403a8a7892"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-macosx_10_12_x86_64.whl",
            "has_sig": false,
            "md5_digest": "4cadfee2ef3b771b6bf4a461a9ff8770",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 471579,
            "upload_time": "2025-02-06T21:28:21",
            "upload_time_iso_8601": "2025-02-06T21:28:21.971017Z",
            "url": "https://files.pythonhosted.org/packages/73/0d/2eca10c1147473d41770323e685baedb0746f9c3eba9fcae8071c84d37a3/navis_fastcore-0.0.9-cp39-abi3-macosx_10_12_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7b3b9944f024559b6c50cd968c66a7a4af2fcd1e12c1adee8d7ad9981013bbfa",
                "md5": "82b342e970ccaafac9e6e1a22ba8308a",
                "sha256": "ffaec23da98bc0cf12058c9f30f57ed6ad8a573427ac2fd500f0c56516b0a757"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-macosx_11_0_arm64.whl",
            "has_sig": false,
            "md5_digest": "82b342e970ccaafac9e6e1a22ba8308a",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 447591,
            "upload_time": "2025-02-06T21:28:24",
            "upload_time_iso_8601": "2025-02-06T21:28:24.064823Z",
            "url": "https://files.pythonhosted.org/packages/7b/3b/9944f024559b6c50cd968c66a7a4af2fcd1e12c1adee8d7ad9981013bbfa/navis_fastcore-0.0.9-cp39-abi3-macosx_11_0_arm64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7bf121d502546f830916fad62327fb9eb0ee9fbeb954f94abdc89e666dbe933e",
                "md5": "a58e9e5fabd7d948ff4bea551422a1aa",
                "sha256": "49463cab8a885b3d3ea8b5e18ce019aa969a8d58820d518b8fc4b235c98edd2b"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-manylinux_2_12_i686.manylinux2010_i686.whl",
            "has_sig": false,
            "md5_digest": "a58e9e5fabd7d948ff4bea551422a1aa",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 517819,
            "upload_time": "2025-02-06T21:28:25",
            "upload_time_iso_8601": "2025-02-06T21:28:25.335672Z",
            "url": "https://files.pythonhosted.org/packages/7b/f1/21d502546f830916fad62327fb9eb0ee9fbeb954f94abdc89e666dbe933e/navis_fastcore-0.0.9-cp39-abi3-manylinux_2_12_i686.manylinux2010_i686.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3e4720db041a4ec2d5d9d51ed5cd68597eb5aa5e864f77c33e662a17b559c452",
                "md5": "38ea085854f235b9e042a64b5de0e6b9",
                "sha256": "b828a23af89f18c1c2193df2ec258ecacc98ee22d706371acdec5329ec5f6035"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
            "has_sig": false,
            "md5_digest": "38ea085854f235b9e042a64b5de0e6b9",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 484647,
            "upload_time": "2025-02-06T21:28:28",
            "upload_time_iso_8601": "2025-02-06T21:28:28.071255Z",
            "url": "https://files.pythonhosted.org/packages/3e/47/20db041a4ec2d5d9d51ed5cd68597eb5aa5e864f77c33e662a17b559c452/navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "503d7538a935f4edca1bcfb96ac04114c26c25447f55adb6e2f3f9691ce28675",
                "md5": "0f8160a36102d6677f67de8d7cc6fcc1",
                "sha256": "1ee4801fd37c23e480ee4e02d61e82c378ed4dcf0b68516387b7533625f5677f"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
            "has_sig": false,
            "md5_digest": "0f8160a36102d6677f67de8d7cc6fcc1",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 506813,
            "upload_time": "2025-02-06T21:28:30",
            "upload_time_iso_8601": "2025-02-06T21:28:30.074686Z",
            "url": "https://files.pythonhosted.org/packages/50/3d/7538a935f4edca1bcfb96ac04114c26c25447f55adb6e2f3f9691ce28675/navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "871b6eb18f7db806534d77d2fb0da0f7038113c16905f6b92fd403e00b7a91f1",
                "md5": "de2d4f63d6cf81c10e57a3e314c696c3",
                "sha256": "71e0a72ec34f011b1f71b90a7769c2254eeff4e5fa3aade44e4262d1479a3c82"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
            "has_sig": false,
            "md5_digest": "de2d4f63d6cf81c10e57a3e314c696c3",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 555242,
            "upload_time": "2025-02-06T21:28:32",
            "upload_time_iso_8601": "2025-02-06T21:28:32.152814Z",
            "url": "https://files.pythonhosted.org/packages/87/1b/6eb18f7db806534d77d2fb0da0f7038113c16905f6b92fd403e00b7a91f1/navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9464c6ec5e06b363ce57bc7ba1dc704d6d89a4bd229fc9cf655f1daf62e8834e",
                "md5": "170cbaa0ffc3b5201a3725659ac226c1",
                "sha256": "38cad09bf0459418194d01ecd1a468689fba1282267316d9f292c7a12f1752e0"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl",
            "has_sig": false,
            "md5_digest": "170cbaa0ffc3b5201a3725659ac226c1",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 709412,
            "upload_time": "2025-02-06T21:28:34",
            "upload_time_iso_8601": "2025-02-06T21:28:34.154016Z",
            "url": "https://files.pythonhosted.org/packages/94/64/c6ec5e06b363ce57bc7ba1dc704d6d89a4bd229fc9cf655f1daf62e8834e/navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9e7435f7767611ba045d2f896bb006a3f782b52c7dbe81b4e42227909c3a6fee",
                "md5": "64b735ce543b49b257d02d087533bdae",
                "sha256": "c09e5443a206485e06b29783357d67e4da82bd9a5aac0e0db900bbafdc33fef3"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "64b735ce543b49b257d02d087533bdae",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 503128,
            "upload_time": "2025-02-06T21:28:36",
            "upload_time_iso_8601": "2025-02-06T21:28:36.013791Z",
            "url": "https://files.pythonhosted.org/packages/9e/74/35f7767611ba045d2f896bb006a3f782b52c7dbe81b4e42227909c3a6fee/navis_fastcore-0.0.9-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a54bd66123ef262a326553179f72426548cf9aeacca3d923544f5f40af1ea1c0",
                "md5": "8fffeed0acee0894f0c2436cae269466",
                "sha256": "df798b494f351b7f513b061d17359329759a29749ece8afcb500904f8794a32d"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-win32.whl",
            "has_sig": false,
            "md5_digest": "8fffeed0acee0894f0c2436cae269466",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 356862,
            "upload_time": "2025-02-06T21:28:37",
            "upload_time_iso_8601": "2025-02-06T21:28:37.434309Z",
            "url": "https://files.pythonhosted.org/packages/a5/4b/d66123ef262a326553179f72426548cf9aeacca3d923544f5f40af1ea1c0/navis_fastcore-0.0.9-cp39-abi3-win32.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "926c077fb1fd9803827515c75c6360e3a21233f7d3bdecad90307f50addabac7",
                "md5": "1e352b47f41b1b9c5218f96d5dc60cc8",
                "sha256": "41f1be3bd0a35c2dc0acbcaf981986454597ea2137d28d2c333119c4280b3641"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9-cp39-abi3-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "1e352b47f41b1b9c5218f96d5dc60cc8",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 380676,
            "upload_time": "2025-02-06T21:28:39",
            "upload_time_iso_8601": "2025-02-06T21:28:39.409046Z",
            "url": "https://files.pythonhosted.org/packages/92/6c/077fb1fd9803827515c75c6360e3a21233f7d3bdecad90307f50addabac7/navis_fastcore-0.0.9-cp39-abi3-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ad6cb198e1fb0457b3bfd4e00dd141ae6b10ee0369dbca9bea0ee261e12273ba",
                "md5": "515e447bf05622c1057425c8166357ad",
                "sha256": "e9a99504c4da765abf077a4168f8a480f43e938ffd79894b1adb6b7b792eeafd"
            },
            "downloads": -1,
            "filename": "navis_fastcore-0.0.9.tar.gz",
            "has_sig": false,
            "md5_digest": "515e447bf05622c1057425c8166357ad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 762369,
            "upload_time": "2025-02-06T21:28:40",
            "upload_time_iso_8601": "2025-02-06T21:28:40.692422Z",
            "url": "https://files.pythonhosted.org/packages/ad/6c/b198e1fb0457b3bfd4e00dd141ae6b10ee0369dbca9bea0ee261e12273ba/navis_fastcore-0.0.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-06 21:28:40",
    "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.43703s