examples.py

# Simple examples to test or demo things
from operator import itemgetter
from galcat.core import *

# Load the database
db = Database()

# All db content
db.db

# Full database as a table of best values
# This is now QTable so df.head() doesn't work
df = db.query_table()
df

# Simple query examples
db.query({'name': 'And XXX'})
db.query({'name': 'And XXX'}, embed_ref=True)  # embed reference dict in place of the reference key
db.query_db({'ra.value': 10.68458})

# Pretty print results, with embedded reference
doc = db.query({'name': 'And XXX'})[0]['ebv'][0]
print(json.dumps(doc, indent=4, sort_keys=False))
doc = db.query_db({'name': 'And XXX'}, embed_ref=True)[0]['ebv'][0]
print(json.dumps(doc, indent=4, sort_keys=False))

# Example to save JSON data to file
doc = db.query_db({'name': 'And XXX'})[0]
db.save_from_db(doc, verbose=True, save=False)
db.save_from_db(doc, save=True)

# Example query with operators ($)
query = {'surface_brightness.value': {'$gt': 27}}
db.query_db(query=query)
df = db.query_table(query=query)
df[['name', 'surface_brightness']]

# Example $exists query
query = {'stellar_radial_velocity_dispersion.value': {'$exists': True}}
db.query_db(query=query)
db.query_table(query=query)[['name', 'stellar_radial_velocity_dispersion']]

# Example AND query
query = {'surface_brightness.value': {'$gt': 27}, 'radial_velocity.value': {'$lte': -100}}
db.query_db(query=query)
db.query_table(query=query)[['name', 'surface_brightness', 'radial_velocity']]

query = {'surface_brightness.value': {'$gt': 27}, 'surface_brightness.error_upper': {'$lte': 0.5}}
db.query_db(query=query)
db.query_table(query=query)[['name', 'surface_brightness']]

# Example OR query
query = {'$or': [{'ra.value': 10.68458}, {'dec.value': 49.64667}]}
db.query_db(query=query)
df = db.query_table(query=query)
df[['name', 'ra', 'dec']]

query = {'surface_brightness.value': {'$gt': 27}, '$or': [{'surface_brightness.error_upper': {'$lte': 0.5}},
                                                          {'surface_brightness.error_lower': {'$gte': 1.0}}]}
db.query_table(query=query)[['name', 'surface_brightness']]
t = db.query_db(query=query)
[x['surface_brightness'] for x in t]
keys = ['name', 'surface_brightness']
[list(itemgetter(*keys)(x)) for x in t]

# TODO: Fails with test_data
query = {'v_mag.value': {'$gt': 20}, '$or': [{'ebv.error_upper': {'$lte': 0.5}}, {'ebv.error_lower': {'$gte': 1.0}}]}
db.query_table(query=query)

# Example table output with requested selection (ra from reference FakeRef2019)
query = {'name': 'And XXX'}
db.query_db(query=query)
db.query_table(query=query)[['name', 'ra', 'dec']]
db.query_table(query=query, selection={'ra': 'FakeRef2019'})[['name', 'ra', 'dec']]

# Query references table
db.query_reference({'id': 1})
db.query_reference({'key': 'Bellazzini_2006_1'})[0]

# Update entries with new data from JSON file
db.load_file_to_db('data/And_XXX.json')  # reset (in case using MongoDB or to undo add data)
db.query_db({'name': 'And XXX'})[0]
db.query_db({'name': 'And XXX'})[0]['ra']
db.query_db({'name': 'And XXX'})[0]['ebv']
db.add_data('new_data.json', update_value=False)  # set update_value to True to overwrite entries
db.query_db({'name': 'And XXX'})[0]['fake_quantity']
db.query_table(query={'name': 'And XXX'}, selection={'ebv': 'Penguin_2020_1'})[['name','ra','ebv']]
db.save_all(out_dir='data')  # explicitly save my changes to disk

# To add and save at the same time (not really recommended, but included for completeness):
db.add_data('new_data.json', save_dir='data', auto_save=True)

# Data validation
from galcat.core import *
db = Database(directory='galcat/tests/test_data')
from galcat.validator import Validator
Validator(database=db, is_data=True, ref_check=True, verbose=True).run()  # against full db
Validator(database=db, db_object='new_data.json', is_data=True, ref_check=True).run() # run against JSON file

doc = {"name": "Gal 3",
       "ra": [{"value": 9.14542, "best": 1, "reference": "", "unit": "deg"}],
       "dec": [{"value": 49.64667, "best": 1, "reference": "", "unit": "deg"}],
       "ebv": [{"value": 0.166, "best": 1, "reference": "Bellazzini_2006_1"}]}
Validator(database=db, db_object=doc, is_data=True, ref_check=True).run()  # against dict-like doc


# Using mongodb
# If localhost you must be running a local mongodb server
from galcat.core import *
db = Database(conn_string='localhost', mongo_db_name='GalaxyCat', collection_name='galaxies')

# If no database exists, can create it from the directory (will also update existing documents)
# db.load_all('data')
# Update references, if needed
# db.update_references_mongodb('references.json')

# All queries from above (should) work the same in MongoDB
doc = db.query_db({'name': 'And XXX'})[0]
db.save_from_db(doc, verbose=True, save=False)