apic-tools


Nameapic-tools JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryA Python package for APIC functionality
upload_time2025-07-22 13:22:42
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords python apic
VCS
bugtrack_url
requirements build twine
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyAPIC
[![PyPI](https://img.shields.io/pypi/v/pyAPIC.svg)](https://pypi.org/project/pyAPIC/)
[![Documentation](https://readthedocs.org/projects/pyapic/badge/?version=latest)](https://pyapic.readthedocs.io/)

## Terminology

Recent versions adopt clearer naming for acquisition parameters:

| New name   | Old name      | Description                            |
|------------|---------------|----------------------------------------|
| `illum_px` | `freqXY_calib`| LED positions in pixel coordinates     |
| `illum_na` | `na_calib`    | LED positions expressed in NA units    |
| `system_na`| `na_cal`      | System numerical aperture              |
| `system_na_px` | `na_rp_cal` | System NA in pixel units               |
| `pixel_size` | `dpix_c`    | Camera pixel size                      |

The old attribute names remain available as aliases for backward
compatibility but new code should prefer the terms above.

## Development setup

Install runtime dependencies:

```bash
pip install -r requirements.txt
```

Then install the package with its development extras:

```bash
pip install -e .[dev]
```

This provides tooling for testing and linting the project.

## Public API

The following convenience imports are available from the top-level package:

```python
from pyAPIC import (
    Case,
    ImagingData,
    ReconParams,
    load_mat,
    to_pixel_coords,
)

```

They mirror the underlying modules located in ``pyAPIC.core`` and
``pyAPIC.io`` and may be used in examples and user code.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "apic-tools",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "bancalari404 <j.bancalari@student.tugraz.at>",
    "keywords": "python, apic",
    "author": null,
    "author_email": "bancalari404 <j.bancalari@student.tugraz.at>",
    "download_url": "https://files.pythonhosted.org/packages/5c/6c/f46413d2507e3b36f7cf7d57dd983f3074d912cb92fb080906889e1b6d0b/apic_tools-0.1.0.tar.gz",
    "platform": null,
    "description": "# pyAPIC\n[![PyPI](https://img.shields.io/pypi/v/pyAPIC.svg)](https://pypi.org/project/pyAPIC/)\n[![Documentation](https://readthedocs.org/projects/pyapic/badge/?version=latest)](https://pyapic.readthedocs.io/)\n\n## Terminology\n\nRecent versions adopt clearer naming for acquisition parameters:\n\n| New name   | Old name      | Description                            |\n|------------|---------------|----------------------------------------|\n| `illum_px` | `freqXY_calib`| LED positions in pixel coordinates     |\n| `illum_na` | `na_calib`    | LED positions expressed in NA units    |\n| `system_na`| `na_cal`      | System numerical aperture              |\n| `system_na_px` | `na_rp_cal` | System NA in pixel units               |\n| `pixel_size` | `dpix_c`    | Camera pixel size                      |\n\nThe old attribute names remain available as aliases for backward\ncompatibility but new code should prefer the terms above.\n\n## Development setup\n\nInstall runtime dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\nThen install the package with its development extras:\n\n```bash\npip install -e .[dev]\n```\n\nThis provides tooling for testing and linting the project.\n\n## Public API\n\nThe following convenience imports are available from the top-level package:\n\n```python\nfrom pyAPIC import (\n    Case,\n    ImagingData,\n    ReconParams,\n    load_mat,\n    to_pixel_coords,\n)\n\n```\n\nThey mirror the underlying modules located in ``pyAPIC.core`` and\n``pyAPIC.io`` and may be used in examples and user code.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python package for APIC functionality",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/bancalari404/pyAPIC/issues",
        "Documentation": "https://pyapic.readthedocs.io/",
        "Homepage": "https://github.com/bancalari404/pyAPIC",
        "Repository": "https://github.com/bancalari404/pyAPIC"
    },
    "split_keywords": [
        "python",
        " apic"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e9e83dc953d5f1dd7f4e01c56f836acd064f31f4a86301a5b5ab9c8cb4a9039b",
                "md5": "93df78c5c61db4e01c1dd2736f556abd",
                "sha256": "b706b471ec0dd6629c8a2f66206e6195daae5157bc6536113a85ef8b8b76dc23"
            },
            "downloads": -1,
            "filename": "apic_tools-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93df78c5c61db4e01c1dd2736f556abd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 14876,
            "upload_time": "2025-07-22T13:22:41",
            "upload_time_iso_8601": "2025-07-22T13:22:41.255785Z",
            "url": "https://files.pythonhosted.org/packages/e9/e8/3dc953d5f1dd7f4e01c56f836acd064f31f4a86301a5b5ab9c8cb4a9039b/apic_tools-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5c6cf46413d2507e3b36f7cf7d57dd983f3074d912cb92fb080906889e1b6d0b",
                "md5": "3788a95a475bb6421f854055ecc1f4d5",
                "sha256": "028f6002d0f32baa33d2e0087a236715bcf4a504ba74c1cce1a72cbf0d8c37a1"
            },
            "downloads": -1,
            "filename": "apic_tools-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3788a95a475bb6421f854055ecc1f4d5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 16574,
            "upload_time": "2025-07-22T13:22:42",
            "upload_time_iso_8601": "2025-07-22T13:22:42.374955Z",
            "url": "https://files.pythonhosted.org/packages/5c/6c/f46413d2507e3b36f7cf7d57dd983f3074d912cb92fb080906889e1b6d0b/apic_tools-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-22 13:22:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bancalari404",
    "github_project": "pyAPIC",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "build",
            "specs": [
                [
                    ">=",
                    "1.0"
                ]
            ]
        },
        {
            "name": "twine",
            "specs": [
                [
                    ">=",
                    "4.0"
                ]
            ]
        }
    ],
    "lcname": "apic-tools"
}
        
Elapsed time: 0.48977s