astro-ranch

Name	astro-ranch JSON
Version	0.1.0 JSON
	download
home_page	https://github.com/einigl/ranch
Summary	Radio AstroNomy Cubes Handler (RANCH)
upload_time	2024-10-01 22:01:08
maintainer	None
docs_url	None
author	Lucas Einig
requires_python	>=3.9
license	None
keywords	radio astronomy data cubes fits
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage

            # Radio AstroNomy Cubes Handler (RANCH)

[![PyPI version](https://badge.fury.io/py/astro-ranch.svg)](https://badge.fury.io/py/astro-ranch)
[![Documentation Status](https://readthedocs.org/projects/ranch/badge/?version=latest)](https://ranch.readthedocs.io/en/latest/?badge=latest)
![test coverage](./coverage.svg)

An API to easily handle radio astronomy FITS files with Python.


## Installation

*(optional)* Create a virtual environment and activate it:

```shell
python -m venv .venv
source .venv/bin/activate
```

**Note 1:** to deactivate the virtual env :

```shell
deactivate
```

**Note 2:** To delete the virtual environment:

```shell
rm -r .venv
```

### From PyPI (recommanded)

To install `ranch`:

```shell
pip install astro-ranch
```

### From local package

To get the source code:

```shell
git clone git@github.com:einigl/ranch.git
```

To install `ranch`:

```shell
pip install -e .
```


## Get started

To get started, check out the Jupyter notebooks provided in the `examples` folder.


## Tests

To test, run:

```shell
pytest --cov && coverage-badge -o coverage.svg -f
```

## Documentation

```bash
cd docs
sphinx-apidoc -o . ../ranch
make html
```

Outputs are in `docs/_build/html`.


## Features

TODO


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/einigl/ranch",
    "name": "astro-ranch",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "radio astronomy, data cubes, fits",
    "author": "Lucas Einig",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/82/bd/05e966da5340365aed3244138fc4dcc83ad4d71c6f24d329e71ff1c5dee8/astro_ranch-0.1.0.tar.gz",
    "platform": null,
    "description": "# Radio AstroNomy Cubes Handler (RANCH)\n\n[![PyPI version](https://badge.fury.io/py/astro-ranch.svg)](https://badge.fury.io/py/astro-ranch)\n[![Documentation Status](https://readthedocs.org/projects/ranch/badge/?version=latest)](https://ranch.readthedocs.io/en/latest/?badge=latest)\n![test coverage](./coverage.svg)\n\nAn API to easily handle radio astronomy FITS files with Python.\n\n\n## Installation\n\n*(optional)* Create a virtual environment and activate it:\n\n```shell\npython -m venv .venv\nsource .venv/bin/activate\n```\n\n**Note 1:** to deactivate the virtual env :\n\n```shell\ndeactivate\n```\n\n**Note 2:** To delete the virtual environment:\n\n```shell\nrm -r .venv\n```\n\n### From PyPI (recommanded)\n\nTo install `ranch`:\n\n```shell\npip install astro-ranch\n```\n\n### From local package\n\nTo get the source code:\n\n```shell\ngit clone git@github.com:einigl/ranch.git\n```\n\nTo install `ranch`:\n\n```shell\npip install -e .\n```\n\n\n## Get started\n\nTo get started, check out the Jupyter notebooks provided in the `examples` folder.\n\n\n## Tests\n\nTo test, run:\n\n```shell\npytest --cov && coverage-badge -o coverage.svg -f\n```\n\n## Documentation\n\n```bash\ncd docs\nsphinx-apidoc -o . ../ranch\nmake html\n```\n\nOutputs are in `docs/_build/html`.\n\n\n## Features\n\nTODO\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Radio AstroNomy Cubes Handler (RANCH)",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/einigl/ism-model-nn-approximation/issues",
        "Documentation": "https://ism-model-nn-approximation.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/einigl/ranch",
        "Repository": "https://github.com/einigl/ranch"
    },
    "split_keywords": [
        "radio astronomy",
        " data cubes",
        " fits"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cc5ea8be015b914af2e1d658da8a580ccc6ec6d13938451f3e485f9e90b1cd51",
                "md5": "3038d1362e5388f33db9d45f041934f5",
                "sha256": "35c5ca5fbb20201a7188cecb04c15025d45fb808045e663d34277d983aa6ce47"
            },
            "downloads": -1,
            "filename": "astro_ranch-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3038d1362e5388f33db9d45f041934f5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 39051,
            "upload_time": "2024-10-01T22:01:07",
            "upload_time_iso_8601": "2024-10-01T22:01:07.313225Z",
            "url": "https://files.pythonhosted.org/packages/cc/5e/a8be015b914af2e1d658da8a580ccc6ec6d13938451f3e485f9e90b1cd51/astro_ranch-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "82bd05e966da5340365aed3244138fc4dcc83ad4d71c6f24d329e71ff1c5dee8",
                "md5": "d4d2638b19312200fd214f59874b98ca",
                "sha256": "2ad118e4d31fcb1c6047ed4d533c2f26850223ff33c40f2df73079adf00505fc"
            },
            "downloads": -1,
            "filename": "astro_ranch-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d4d2638b19312200fd214f59874b98ca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 32928,
            "upload_time": "2024-10-01T22:01:08",
            "upload_time_iso_8601": "2024-10-01T22:01:08.688836Z",
            "url": "https://files.pythonhosted.org/packages/82/bd/05e966da5340365aed3244138fc4dcc83ad4d71c6f24d329e71ff1c5dee8/astro_ranch-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-01 22:01:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "einigl",
    "github_project": "ranch",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "astro-ranch"
}