pyHIARD 1.1.2

Development Status :: 1 - Beta

pyHIARD

The Python HI Artificial and Real Database (pyHIARD ) is a project to create a comprehensive database of Artificial and real galaxies that can be used for testing the various software that is available for fitting galaxy survey. In principle it is developed for testing Tilted Ring Fitting Software but in principle it can be used for testing any Software for which the input parameters should be known.

pyHIARD Requires working versions of tirific, casa and sofia2 for full functionality.

CASA is required for full simulations but if you are only interested in Gaussian corruption it can be omitted.

tirific is required for the Artificial branch and can be installed trough kern-suite https://kernsuite.info/ for ubuntu or it can be downloaded from https://github.com/gigjozsa/tirific. If you are struggling with tirific's pg plot dependency the branch no_pgp can be installed from the github. It wll work with pyHIARD

SoFiA2 is required for the masking and can be downloaded from https://github.com/SoFiA-Admin/SoFiA-2

Except for The Real Observed Catalogue should work without any external installations as long as no new galaxies are added. Do note that at the first instance of creating a base galaxy it requires an internet connection to download the original cubes. An origins disclaimer will be positions in each directory.

Please see the read the docs pages for additional information and set up.

Installation

Download the source code from the Github or simply install with pip as:

pip install pyHIARD

This should also install all required python dependencies. We recommend the use of python virtual environments. If so desired a pyHIARD installation would look like:

python3 -m venv pyHIARD_venv

source pyHIARD_venv/bin/activate.csh

pip install --upgrade wheel setuptools pip

pip install pyHIARD

(In case of bash the correct middle line is source pyHIARD_venv/bin/activate) You might have to restart the env:

deactivate

source pyHIARD_venv/bin/activate.csh

Once you have installed HIARD you can check that it has been installed properly by running HIARD as.

pyHIARD installation_check=True

Running pyHIARD

cd to the directory where you want the database to exist. run pyHIARD by typing:

pyHIARD configuration_file=my_setup.yml

or

pyHIARD

answer the questions about what you want to create.