Updated README.md

guillochon · Feb 26, 2017 · c299227 · c299227
1 parent 1c7a134
commit c299227
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Python Version](https://img.shields.io/badge/python-2.7%2C%203.4%2C%203.5%2C%203.6-blue.svg)](https://www.python.org)
 [![PyPI version](https://badge.fury.io/py/mosfit.svg)](https://badge.fury.io/py/mosfit)
 
-`MOSFiT` (**M**odular **O**pen-**S**ource **Fi**tter for **T**ransients) is a Python 2.7/3.x package that performs maximum likelihood analysis to fit semi-analytical model predictions to observed transient data. Data can be provided by the user, or can be pulled automatically from the [Open Supernova Catalog](https://sne.space) by its name, and thus the code can be used to fit *any* supernova within that database, or any database that shares the format described in the [OSC schema](https://github.com/astrocatalogs/supernovae/blob/master/SCHEMA.md) (such as the [Open TDE Catalog](https://tde.space) or the [Open Nova Catalog](https://opennova.space)).<br clear="all">
+`MOSFiT` (**M**odular **O**pen-**S**ource **Fi**tter for **T**ransients) is a Python 2.7/3.x package that performs maximum likelihood analysis to fit semi-analytical model predictions to observed transient data. Data can be provided by the user, or can be pulled automatically from the [Open Supernova Catalog](https://sne.space) by its name, and thus the code can be used to fit *any* supernova within that database, or any database that shares the format described in the [OSC schema](https://github.com/astrocatalogs/supernovae/blob/master/SCHEMA.md) (such as the [Open TDE Catalog](https://tde.space) or the [Open Nova Catalog](https://opennova.space)). With the use of an optional upload flag, fits performed by users can then be uploaded back to the aforementioned catalogs.<br clear="all">
 
 ##Getting Started
 
@@ -29,6 +29,12 @@ Then, to run `MOSFiT`, pass an event name to the program via the `-e` flag (the
 python -m mosfit -e LSQ12dlf
 ```
 
+Different models (several are distributed with MOSFiT) can be fit to supernovae using the model flag `-m`:
+
+```bash
+python -m mosfit -e LSQ12dlf -m slsn
+```
+
 Multiple events can be fit in succession by passing a list of names separated by spaces (names containing spaces can be specified using quotation marks):
 
 ```bash
@@ -48,3 +54,11 @@ mpirun -np 5 python -m mosfit -i 0 -m magnetar
 ```
 
 The code outputs JSON files for each event/model combination that each contain a set of walkers that have been relaxed into an equilibrium about the combinations of parameters with the maximum likelihood. This output is visualized via an example Jupyter notebook (`mosfit.ipynb`) included with the software in the main directory, which by default shows output from the last `MOSFiT` run.
+
+To upload fits back to the open astronomy catalogs, users simply pass the `-u` to the the code:
+
+```bash
+python -m mosfit -e LSQ12dlf -m slsn
+```
+
+If the fits satisfy some quality checks, the model fits will be displayed on the open catalogs within 48 hours of their submission.