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://167.99.90.204:8080/buildStatus/icon?job=marshallEngine%2Fmaster&subject=build%20master http://167.99.90.204: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.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.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.create_lc

create the atlas lc for one transient

marshallEngine.feeders.atlas.lightcurve.create_lc_depreciated

create the atlas lc for one transient

marshallEngine.feeders.atlas.lightcurve.generate_atlas_lightcurves

generate atlas lightcurves

Release Notes

v1.0.0 - May 28, 2020

  • Now compatible with Python 3.*