Metadata-Version: 2.1
Name: dlg_casacore_components
Version: 0.3.0
Summary: casacore components for daliuge-engine created by ICRAR
Home-page: https://github.com/ICRAR/dlg-casacore-components
Author: ICRAR DIA Group
Author-email: dfms_prototype@googlegroups.com
License: GNU General Public License v2 or later (GPLv2+)
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

# dlg-casacore-components

[![codecov](https://codecov.io/gh/ICRAR/dlg-casacore-components/branch/main/graph/badge.svg?token=dlg-casacore-components_token_here)](https://codecov.io/gh/ICRAR/dlg-casacore-components)
[![CI](https://github.com/ICRAR/dlg-casacore-components/actions/workflows/main.yml/badge.svg)](https://github.com/ICRAR/dlg-casacore-components/actions/workflows/main.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Awesome dlg_casacore_components created by ICRAR

## Installation

There are multiple options for the installation, depending on how you are intending to run the DALiuGE engine, directly in a virtual environment (host) or inside a docker container. You can also install it either from PyPI (latest released version).

## Install it from PyPI

### Engine in virtual environment

```bash
pip install dlg_casacore_components
```

### Engine in Docker container

```bash
docker exec -t daliuge-engine bash -c 'pip install --prefix=$DLG_ROOT/code dlg_casacore_components'
```

## Usage

For example the MyComponent component will be available to the engine when you specify

```python
from dlg_casacore_components import MSReadApp
MSReadApp('a', 'a')
```

in the AppClass field of a Python Branch component. The EAGLE palette associated with these components are also generated and can be loaded directly into EAGLE. In that case all the fields are correctly populated for the respective components.

## Linting and Testing

Testing and linting is performed per branch push. Additionally this can be performed locally with docker using the following command:

```bash
docker build -t dlg-casacore-components . -f debian.Containerfile && docker run -it --rm --shm-size 1G dlg-casacore-components
```

