hotaru


Namehotaru JSON
Version 5.0.1 PyPI version JSON
download
home_pagehttps://github.com/tk2lab/HOTARU
SummaryHigh performance Optimizer to extract spike Timing And cell location from calcium imaging data via lineaR impUlse
upload_time2023-10-07 00:06:41
maintainer
docs_urlNone
authorTAKEKAWA Takashi
requires_python>=3.10,<3.12
licenseGPL-3.0-only
keywords calcium imaging spike detection cell extraction
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # HOTARU

High performance Optimizer to extract spike Timing And cell location from calcium imaging data via lineaR impUlse

### Author
TAKEKAWA Takashi <takekawa@tk2lab.org>

### References
- Takekawa., T, et. al.,
  bioRxiv, https://biorxiv.org/content/10.1101/2022.04.05.487077v2 (2023).
- Takekawa., T, et. al.,
  bioRxiv, https://biorxiv.org/content/10.1101/2022.04.05.487077v1 (2022).
- Takekawa., T, et. al.,
  bioRxiv, https://www.biorxiv.org/content/10.1101/215145 (2017).


## Install

### Require
- python >=3.10,<3.12
- jax >= 0.4

### Recommended
- Nvidia GPU
- cuda 12.0
- cudnn 8.9

### Install Procedure (using venv)
- Create venv environment for hotaru
```shell
python3.10 -m venv hotaru
```
- Activate hotaru environment
```shell
source hotaru/bin/activate
```
- Install hotaru
```shell
pip install hotaru
```


## Usage
see help
```shell
hotaru --help
```


## Demonstration
Download [sample.tif](https://drive.google.com/drive/u/0/folders/1yZK8vU1WOyCMuU-ogiSB7FJcZUxU8QtP)
```shell
hotaru data.imgs.file=sample.tif mode=test
# see figs/test_*.pdf
hotaru data.imgs.file=sample.tif mode=run
# see figs/run_*.pdf
```

[Demo Movies](https://drive.google.com/drive/folders/1yZK8vU1WOyCMuU-ogiSB7FJcZUxU8QtP?usp=sharing)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tk2lab/HOTARU",
    "name": "hotaru",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<3.12",
    "maintainer_email": "",
    "keywords": "Calcium Imaging,Spike Detection,Cell Extraction",
    "author": "TAKEKAWA Takashi",
    "author_email": "takekawa@tk2lab.org",
    "download_url": "https://files.pythonhosted.org/packages/61/e6/1ad64fcf1c31a7f196a643bf9bffba4b10d91f5d2f60a744cef6e481ea58/hotaru-5.0.1.tar.gz",
    "platform": null,
    "description": "# HOTARU\n\nHigh performance Optimizer to extract spike Timing And cell location from calcium imaging data via lineaR impUlse\n\n### Author\nTAKEKAWA Takashi <takekawa@tk2lab.org>\n\n### References\n- Takekawa., T, et. al.,\n  bioRxiv, https://biorxiv.org/content/10.1101/2022.04.05.487077v2 (2023).\n- Takekawa., T, et. al.,\n  bioRxiv, https://biorxiv.org/content/10.1101/2022.04.05.487077v1 (2022).\n- Takekawa., T, et. al.,\n  bioRxiv, https://www.biorxiv.org/content/10.1101/215145 (2017).\n\n\n## Install\n\n### Require\n- python >=3.10,<3.12\n- jax >= 0.4\n\n### Recommended\n- Nvidia GPU\n- cuda 12.0\n- cudnn 8.9\n\n### Install Procedure (using venv)\n- Create venv environment for hotaru\n```shell\npython3.10 -m venv hotaru\n```\n- Activate hotaru environment\n```shell\nsource hotaru/bin/activate\n```\n- Install hotaru\n```shell\npip install hotaru\n```\n\n\n## Usage\nsee help\n```shell\nhotaru --help\n```\n\n\n## Demonstration\nDownload [sample.tif](https://drive.google.com/drive/u/0/folders/1yZK8vU1WOyCMuU-ogiSB7FJcZUxU8QtP)\n```shell\nhotaru data.imgs.file=sample.tif mode=test\n# see figs/test_*.pdf\nhotaru data.imgs.file=sample.tif mode=run\n# see figs/run_*.pdf\n```\n\n[Demo Movies](https://drive.google.com/drive/folders/1yZK8vU1WOyCMuU-ogiSB7FJcZUxU8QtP?usp=sharing)\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-only",
    "summary": "High performance Optimizer to extract spike Timing And cell location from calcium imaging data via lineaR impUlse",
    "version": "5.0.1",
    "project_urls": {
        "Homepage": "https://github.com/tk2lab/HOTARU",
        "Repository": "https://github.com/tk2lab/HOTARU"
    },
    "split_keywords": [
        "calcium imaging",
        "spike detection",
        "cell extraction"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eb67d5cb8aa9b194c6199c3b245bad2c18aafe17d172731638610e340bc89c31",
                "md5": "f6ec8d2698c2222c217b77564489cf5b",
                "sha256": "e9d2095e35e462fb8a89b0657ebdccb6ee7d61b4a2815d2e415ee4b5544bcbba"
            },
            "downloads": -1,
            "filename": "hotaru-5.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f6ec8d2698c2222c217b77564489cf5b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<3.12",
            "size": 101913,
            "upload_time": "2023-10-07T00:06:39",
            "upload_time_iso_8601": "2023-10-07T00:06:39.914344Z",
            "url": "https://files.pythonhosted.org/packages/eb/67/d5cb8aa9b194c6199c3b245bad2c18aafe17d172731638610e340bc89c31/hotaru-5.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "61e61ad64fcf1c31a7f196a643bf9bffba4b10d91f5d2f60a744cef6e481ea58",
                "md5": "aaa408422c23befbfb2ec6a016bbfa49",
                "sha256": "e479440666ddc202a97e2fd9fa6546184553f117ea4695a0fdc0d81de00aa53f"
            },
            "downloads": -1,
            "filename": "hotaru-5.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "aaa408422c23befbfb2ec6a016bbfa49",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<3.12",
            "size": 65214,
            "upload_time": "2023-10-07T00:06:41",
            "upload_time_iso_8601": "2023-10-07T00:06:41.533490Z",
            "url": "https://files.pythonhosted.org/packages/61/e6/1ad64fcf1c31a7f196a643bf9bffba4b10d91f5d2f60a744cef6e481ea58/hotaru-5.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-07 00:06:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tk2lab",
    "github_project": "HOTARU",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hotaru"
}
        
Elapsed time: 0.12399s