marshallEngine

https://img.shields.io/pypi/pyversions/marshallEngine https://img.shields.io/pypi/v/marshallEngine https://img.shields.io/github/license/thespacedoctor/marshallEngine https://img.shields.io/pypi/dm/marshallEngine

http://157.245.42.153:8080/buildStatus/icon?job=marshallEngine%2Fmaster&subject=build%20master http://157.245.42.153:8080/buildStatus/icon?job=marshallEngine%2Fdevelop&subject=build%20dev https://cdn.jsdelivr.net/gh/thespacedoctor/marshallEngine@master/coverage.svg https://readthedocs.org/projects/marshallEngine/badge/?version=master https://img.shields.io/github/issues/thespacedoctor/marshallEngine/type:%20bug?label=bug%20issues

the engine behind the marshall webapp.

Documentation for marshallEngine is hosted by Read the Docs ( development version and master version). The code lives on github. Please report any issues you find here.

API Reference

Modules

marshallEngine.commonutils

common tools used throughout package

marshallEngine.feeders

Import codes for the various transients surveys that ‘feed’ the marshall inbox

marshallEngine.feeders.atels

import code for the panstarrs survey

marshallEngine.feeders.atlas

import code for the panstarrs survey

marshallEngine.feeders.panstarrs

import code for the panstarrs survey

marshallEngine.feeders.tns

import code for the panstarrs survey

marshallEngine.feeders.useradded

import code for the panstarrs survey

marshallEngine.feeders.ztf

import code for the panstarrs survey

marshallEngine.housekeeping

Housekeeping and bookkeeping actions for the marshall database

marshallEngine.lightcurves

Lightcurve plotting for the Marshall

marshallEngine.services

small services and tools for the marhall

marshallEngine.feeders.atlas.lightcurve

Generate the force-photometry lightcurves for ATLAS sources found in the marshall database

marshallEngine.utKit

Unit testing tools

Classes

marshallEngine.feeders.atels.data

Import the atels transient data into the marshall database

marshallEngine.feeders.atels.images

cacher for the atels image stamps

marshallEngine.feeders.atlas.data

Import the ATLAS transient data into the marshall database

marshallEngine.feeders.atlas.images

cacher for the ATLAS image stamps

marshallEngine.feeders.data

This baseclass for the feeder survey data imports

marshallEngine.feeders.images

The base class for the feeder image cachers

marshallEngine.feeders.panstarrs.data

Import the PanSTARRS transient data into the marshall database

marshallEngine.feeders.panstarrs.images

cacher for the panstarrs image stamps

marshallEngine.feeders.tns.data

Import the tns transient data into the marshall database

marshallEngine.feeders.tns.images

cacher for the tns image stamps

marshallEngine.feeders.useradded.data

Import the useradded transient data into the marshall database

marshallEngine.feeders.useradded.images

cacher for the useradded image stamps

marshallEngine.feeders.ztf.data

Import the ZTF transient data into the marshall database

marshallEngine.feeders.ztf.images

cacher for the ZTF image stamps

marshallEngine.housekeeping.update_transient_summaries

Update the transient summaries table in the marshall database

marshallEngine.lightcurves.marshall_lightcurves

The worker class for the marshall_lightcurves module

marshallEngine.services.panstarrs_location_stamps

The worker class for the panstarrs_location_stamps module

Functions

marshallEngine.commonutils.getpackagepath

Get the root path for this python package

marshallEngine.feeders.atlas.lightcurve.generate_atlas_lightcurves

generate all atlas FP lightcurves (clipped and stacked)

marshallEngine.feeders.atlas.lightcurve.get_twin

marshallEngine.feeders.atlas.lightcurve.get_twin_axis

marshallEngine.feeders.atlas.lightcurve.plot_single_result

plot single result

marshallEngine.feeders.atlas.lightcurve.sigma_clip_data

clean up rouge data from the files by performing some basic clipping

marshallEngine.feeders.atlas.lightcurve.stack_photometry

stack the photometry for the given temporal range

Marshall Engine Release Notes

adding tns-marker into the TNS search requests

v1.0.9 - May 7, 2021

  • REFACTOR: resurrection code optimised to resurface a few more objects

  • REFACTOR: some MySQL queries rewritten and table indexes added to optimise common queries

  • REFACTOR: ATLAS forced photometry plotting code refactored to bring plots in-line with those produced by ATLAS forced photometry server. Biggest improvement is the more robust clipping of outlying data points.

v1.0.8 - March 17, 2021

  • REFACTOR: Occasional check to make sure all akas are set (i.e. more than just for transients discovered in the last 3 weeks).

  • FIXED: Links to the ASASSN Sky Patrol now added to all TNS reported ASASSN transient names (credentials discoverable in hover-over tool-tip)

  • FIXED: ATel comments where getting added correctly to associated object but ticket “ATel” drop-up menu was missing some ATel links occasionally.

v1.0.7 - February 20, 2021

  • ENHANCEMENT: Added cleanup function at end of ingests so objects appear in inbox quicker and akas are updated more frequently

  • REFACTORING: Reduced the crossmatch radius from 7 to 4 arcsec (it is easier to merge than split transients later on)

v1.0.6 - January 29, 2021

  • FEATURE: match transients to astronotes (not yet visualised in the webapp)

  • ENHANCEMENT: HTM indexing added the transientBucketSummaries table so we can spatially crossmatch

v1.0.5 - January 13, 2021

  • REFACTORING: atel parsing and matching within the marshall database now upgraded

v1.0.4 - January 11, 2021

  • REFACTORING: some database schema changes for latest version of Sherlock to run.

  • FIXED: added a function to recalculate sherlock original radii for merged sources. Fixes webapp visualisation.

  • FIXED: reduced number of ATLAS LC to be generated in a single batch.

v1.0.3 - December 10, 2020

  • REFACTORING: reading settings from marshall config folder instead of marshallEngine

  • FIXED: the save location of lightcurve files was resulting in files not being found in webapp

v1.0.2 - November 14, 2020

  • feature PS2 survey added as a new import (discoveries, lightcurves and stamps)

v1.0.1 - October 20, 2020

  • REFACTORING: added time filtering on ATLAS summary CSV file (thanks Ken)

  • FIXED: small fix to panstamp location map downloader

v1.0.0 - May 28, 2020

  • Now compatible with Python 3.* *