astro-ranch 0.1.0

Radio AstroNomy Cubes Handler (RANCH)

Radio AstroNomy Cubes Handler (RANCH)

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

Installation

(optional) Create a virtual environment and activate it:

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

Note 1: to deactivate the virtual env :

deactivate

Note 2: To delete the virtual environment:

rm -r .venv

From PyPI (recommanded)

To install ranch:

pip install astro-ranch

From local package

To get the source code:

git clone [e-mail]:einigl/ranch.git

To install ranch:

pip install -e .

Get started

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

Tests

To test, run:

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

Documentation

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

Outputs are in docs/_build/html.

Features

TODO