Update paper.md

paper/paper.md

@@ -16,21 +16,17 @@ affiliations:
 name: Departamento de Física de la Tierra y Astrofísica and IPARCOS-UCM (Instituto de Física de Partículas y del Cosmos de la UCM), Facultad de Ciencias Físicas, Universidad Complutense de Madrid, E-28040, Madrid, Spain
 index: 1
 
-date: 16 November 2023
+date: 23 November 2023
 
 bibliography: paper.bib
 
 # Summary
 
 Steparkin is a code that uses the Galactic-space velocity components (U, V, W) of the stars to evaluate their membership to young (< 1 Gyr) kinematic moving groups and associations (5 by default) and to assign their stellar populations as proposed by Bensby et al. 2003, 2005. The code takes as input a file that contains the equatorial coordinates (in J2000 and epoch 2000), proper motions, parallax/distance, and radial velocity (along with their corresponding errors) of a star and retrieves a CSV file and a series of plots (UV and UW planes and the Toomre diagram) as outputs. The CSV file contains the Galactic-space velocity components (U, V, W), their corresponding errors (computed following the approach described in '@JohnsonSoderblom1987' ), the associations and/or groups to which the star is candidate, and its most probable stellar population along with the name, the value, and error in radial velocity of the star from the input file.
 
-# Statement of need
-
-bla bla
-
 # Scheme
 
-The code is constituted by 3 main functions:
+The code is constituted by three main functions:
 
 <div><li style="text-align: justify"><b>spk_groups</b>: This function associates stars to a young moving groups or associations if its Galactic-space velocity components are within the 3D ellipsoid that defines each moving group or association. The ellipsoids are defined in the UVW space and their parameters are recorded in the association_parameters.csv file. This function also determines to which stellar population (thin disk (D), thick disk (TD), in between them (TD-D), or halo (H)) the star belongs following the probabilistic approach described in Bensby et al. 2003, 2005. The values of the parameters that define each population (the observed fraction in the solar neighborhood (X_ns), the characteristic velocity dispersions (sig_u, sig_v, sig_w), and the asymmetric drift (v_asym)) are stored in the param_prob_populations.csv file. Note that CSV files must be in the same directory as the function (spk_groups.py) for this to work. The optional parameter file_name takes a string to be included in the names of the output files. The default value is empty.
 
@@ -58,6 +54,26 @@ The input file (spk_wrapper, see below) or input DataFrame (spk_groups) must hav
 
 </blockquote>
 
+The standard output file structure is as follows: 
+
+| Column | Description |
+| :------:|:-----------|
+| NAME |  That provided in the input | 
+| RV |  The value provided in the input | 
+| ERV |  The value provided in the input | 
+| U |  U Galactic-space velocity component in km s-1 (positive towards the Galactic center)  | 
+| eU |  error in the U Galactic-space velocity component in km s-1 | 
+| V |  V Galactic-space velocity component in km s-1 (positive towards the North Galactic Pole)  | 
+| eV |  error in the V Galactic-space velocity component in km s-1 | 
+| W |  W Galactic-space velocity component in km s-1 | 
+| eW |  error in the W Galactic-space velocity component in km s-1 | 
+| lab_YD | indicates if the stars belongs (YD) or not (NYD) to the young disk region defined by Eggen |
+| lab_skg | kinematic moving group, association or range of them to which the star is candidate. Default values are Local Association (LA), Hyades Supercluster (HS), IC 2391 (IC), Ursa Major (UMA) and Castor (CAS), their overlaps (LA/IC, LA/CAS, LA/IC/CAS, and IC/CAS) or neither moving group nor association (NNN). |
+| lab_kin | stellar population: thin disk (D), thick disk (TD), in between them (D-TD), or halo (H). |
+
+<div><li style="text-align: justify"><b>spk_graphs</b>: This function plots Boettlinger diagrams (the UV and UW planes), with and without zoom in on the Eggen's young disk, and the Toomre diagram. This function also makes use of the parameter file association_parameters.csv. The parameters of the function are: </li></div>
+
+
 
 # Acknowledgements