Welcome to Radio AstroNomy Cubes Handler's (RANCH) documentation
================================================================

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 .
```

.. toctree::
   :maxdepth: 4
   :caption: Contents:

   modules

.. toctree::
   :maxdepth: 2

   gallery-examples


Features
========

TODO