marshall_webapp ∞
Astronomical-transient marshalling webapp for curating and managing streams of object observations generated by wide-field surveys.
Documentation for marshall_webapp is hosted by Read the Docs ( development version and master version). The code lives on github. Please report any issues you find here.
Features ∞
Installation ∞
The easiest way to install marshall_webapp is to use pip (here we show the install inside of a conda environment):
conda create -n marshall_webapp python=3.7 pip
conda activate marshall_webapp
pip install marshall_webapp
Or you can clone the github repo and install from a local version of the code:
git clone git@github.com:thespacedoctor/marshall_webapp.git
cd marshall_webapp
python setup.py install
To upgrade to the latest version of marshall_webapp use the command:
pip install marshall_webapp --upgrade
To check installation was successful run marshall_webapp -v. This should return the version number of the install.
Development ∞
If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:
git clone git@github.com:thespacedoctor/marshall_webapp.git
cd marshall_webapp
python setup.py develop
Pull requests are welcomed!
Initialisation ∞
Before using marshall_webapp you need to use the init command to generate a user settings file. Running the following creates a yaml settings file in your home folder under ~/.config/marshall_webapp/marshall_webapp.yaml:
marshall_webapp init
The file is initially populated with marshall_webapp’s default settings which can be adjusted to your preference.
If at any point the user settings file becomes corrupted or you just want to start afresh, simply trash the marshall_webapp.yaml file and rerun marshall_webapp init.
Modifying the Settings ∞
Once created, open the settings file in any text editor and make any modifications needed.
Basic Python Setup ∞
If you plan to use marshall_webapp in your own scripts you will first need to parse your settings file and set up logging etc. One quick way to do this is to use the fundamentals package to give you a logger, a settings dictionary and a database connection (if connection details given in settings file):
## SOME BASIC SETUP FOR LOGGING, SETTINGS ETC
from fundamentals import tools
from os.path import expanduser
home = expanduser("~")
settingsFile = home + "/.config/marshall_webapp/marshall_webapp.yaml"
su = tools(
arguments={"settingsFile": settingsFile},
docString=__doc__,
)
arguments, settings, log, dbConn = su.setup()
Todo List ∞
Todo
add usage info
create a sublime snippet for usage
add a tutorial about
models_transients_comments_element_postto documentationcreate a blog post about what
models_transients_comments_element_postdoess
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/marshall-webapp/envs/master/lib/python3.8/site-packages/marshall_webapp-3.1.1-py3.8.egg/marshall_webapp/models/transients_comments/element/models_transients_comments_element_post.py:docstring of marshall_webapp.models.transients_comments.element.models_transients_comments_element_post.models_transients_comments_element_post, line 16.)
Todo
add usage info
create a sublime snippet for usage
add a tutorial about
models_transients_comments_element_putto documentationcreate a blog post about what
models_transients_comments_element_putdoes
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/marshall-webapp/envs/master/lib/python3.8/site-packages/marshall_webapp-3.1.1-py3.8.egg/marshall_webapp/models/transients_comments/element/models_transients_comments_element_put.py:docstring of marshall_webapp.models.transients_comments.element.models_transients_comments_element_put.models_transients_comments_element_put, line 16.)
Todo
nice!
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/marshall-webapp/checkouts/master/docs/source/_template_.md, line 1.)
Marshall Webapp Release Notes ∞
best name is selected in both table view and plain-text outputs json output now reports akas (name and url) for each transient fixed csv and plain text downloads allow for debug toolbar over https
v3.1.1 - May 7, 2021
ENHANCEMENT: SSL certificate now installed on the pessto.org domain. All traffic is now encrypted and secure. All
httprequests should also be redirected tohttps.FIXED: classification summary info on each ticket is now the latest and most relevant. At times an older redshift report was being presented.
v3.1.0 - March 17, 2021
REFACTOR search function more forgiving, but also more accurate and MUCH faster
REFACTOR adding new sources via the “create new ticket button” now faster
ENHANCEMENT AT/SN names now set as the ‘master’ or headline name in each transient ticket. All other names and links added to aka section.
ENHANCEMENT: added light echo to classification options
FIXED: issue where transient history logs were not getting parsed correctly resulting in ticket not loading in marshall interface
FIXED database connector, needed to create new tickets and add classifications, pings MySQL server and reconnects if connection is broken before executing actions. This hopefully fixes the long-standing issues with these 2 features.
v3.0.9 - January 11, 2021
FEATURE documentation for the marshall webapp is on readthedocs. This is mainly for developer reference so far.
FIXED the context visualisation is now displaying correctly to show all sherlock crossmatches (see context tab on transient tickets)
v3.0.8 - December 15, 2020
REFACTOR added ability to set classification priority when moving ticket to classification list
FIXED fixing cache links so images appear and downloads work correctly
v3.0.7 - December 4, 2020
REFACTOR settings files clean up and consolidation
FIXED classification bug squashed
v3.0.6 - December 4, 2020
REFACTOR moved a sherlock book-keeping query from front-end code to database procedure. Should decrease page load times.
FIXED sorting lists on ‘latest comment’.
v3.0.5 - December 3, 2020
FIXED date formats, broken aka links, broken stats pages and broken table view
v3.0.4 - December 2, 2020
FIXED comment function (legacy unicode fix)
v3.0.3 - December 2, 2020
FIXED search function
v3.0.2 - November 17, 2020
Enhancement added config files for cluster
Enhancement added ability to connect to a non-standard database port issue
v3.0.1 - July 6, 2020
Fixed unittest database import metadata lock issue
Fixed bug in search resource
v3.0.0 - June 25, 2020
Now compatible with Python 3.*
API Reference ∞
Modules ∞
Classes ∞
Functions ∞
A-Z Index ∞
Modules
Classes
Functions
Marshall Webapp Release Notes ∞
best name is selected in both table view and plain-text outputs json output now reports akas (name and url) for each transient fixed csv and plain text downloads allow for debug toolbar over https
v3.1.1 - May 7, 2021
ENHANCEMENT: SSL certificate now installed on the pessto.org domain. All traffic is now encrypted and secure. All
httprequests should also be redirected tohttps.FIXED: classification summary info on each ticket is now the latest and most relevant. At times an older redshift report was being presented.
v3.1.0 - March 17, 2021
REFACTOR search function more forgiving, but also more accurate and MUCH faster
REFACTOR adding new sources via the “create new ticket button” now faster
ENHANCEMENT AT/SN names now set as the ‘master’ or headline name in each transient ticket. All other names and links added to aka section.
ENHANCEMENT: added light echo to classification options
FIXED: issue where transient history logs were not getting parsed correctly resulting in ticket not loading in marshall interface
FIXED database connector, needed to create new tickets and add classifications, pings MySQL server and reconnects if connection is broken before executing actions. This hopefully fixes the long-standing issues with these 2 features.
v3.0.9 - January 11, 2021
FEATURE documentation for the marshall webapp is on readthedocs. This is mainly for developer reference so far.
FIXED the context visualisation is now displaying correctly to show all sherlock crossmatches (see context tab on transient tickets)
v3.0.8 - December 15, 2020
REFACTOR added ability to set classification priority when moving ticket to classification list
FIXED fixing cache links so images appear and downloads work correctly
v3.0.7 - December 4, 2020
REFACTOR settings files clean up and consolidation
FIXED classification bug squashed
v3.0.6 - December 4, 2020
REFACTOR moved a sherlock book-keeping query from front-end code to database procedure. Should decrease page load times.
FIXED sorting lists on ‘latest comment’.
v3.0.5 - December 3, 2020
FIXED date formats, broken aka links, broken stats pages and broken table view
v3.0.4 - December 2, 2020
FIXED comment function (legacy unicode fix)
v3.0.3 - December 2, 2020
FIXED search function
v3.0.2 - November 17, 2020
Enhancement added config files for cluster
Enhancement added ability to connect to a non-standard database port issue
v3.0.1 - July 6, 2020
Fixed unittest database import metadata lock issue
Fixed bug in search resource
v3.0.0 - June 25, 2020
Now compatible with Python 3.*