Skip to content

Latest commit

 

History

History
79 lines (65 loc) · 2.82 KB

README.md

File metadata and controls

79 lines (65 loc) · 2.82 KB
Raw

fits2db

fits2db: A cli tool to ingest fits files into an sql db
Testing CI - Test codecov linting: pylint
Package PyPI Latest Release PyPI Downloads
Docs CI - DOCS Find Here

This is a cli tool to extract table data from a fits file and write it down in a database.

Supported databases

Database Supported
MySql & MariaDB YES
DuckDB In progress
Postgres under validation

Installation

For installation you can use pip

pip install fits2db

check if you got the right version with

fits2db --version

To init a config file run

fits2db init

In the config.yml file you now can change the variables needed.

Fill in the database credentials:

database:
  type: mysql
  host: localhost
  user: user
  password: password
  db_name: test_db
  port: 3306

and add some paths for your fits files

fits_files:
  paths:
    - path/to_your_file/2021-07-07_L1a.fits
    - path_to_your_folder
tables:
    - name: HOUSEKEEPING
      target_table: RAW_HOUSEKEEPING # This will be the table_name in the db
    - name: OTHER_TABLE # If no table name given it will use the orignal name

Build your database from config file

fits2db build <path_to_config_yaml>

This will create the following tables:

Table Description
FITS2DB_META Contain meta information about loaded files
FITS2DB_TABLE_META Contains info about all loaded tables from the files
HOUSEKEEPING Contains the data of your fits files tables HOUSEKEEPING merged
HOUSEKEEPING_META Contains the Column information from the fits files
OTHER_TABLE Contains the data of your fits files tables HOUSEKEEPING merged
OTHER_TABLE_META Contains the Column information from the fits files