This FITCH_readme_code_20200603.txt file was generated on 20200603 by Kyle Fitch ------------------- GENERAL INFORMATION ------------------- 1. Title of Dataset Corrected Liquid Water Path Data and mascpy code for "Graupel Precipitating from Thin Arctic Clouds with Liquid Water Paths less than 50 g m-2" 2. Author Information Fitch, Kyle E. and Timothy J. Garrett Principal Investigator Contact Information Name: Tim Garrett Institution: Dept. of Atmospheric Sciences, University of Utah Address: 135 S 1460 E, William Browning Building Email: tim.garrett@utah.edu Associate or Co-investigator Contact Information Name: Kyle Fitch Institution: Dept. of Atmospheric Sciences, University of Utah Address: 135 S 1460 E, William Browning Building Email: kyle.fitch@utah.edu Alternate Contact Information Name: Institution: Address: Email: 3. Date of data collection (single date, range, approximate date) Code creation dates from 20161208 to 20180609 according to file creation dates 4. Geographic location of data collection (where was data collected?): N/A 5. Information about funding sources that supported the collection of the data: This work is supported by the U.S. Department of Energy (DOE) Atmospheric System Research program (DE-SC0016282). -------------------------- SHARING/ACCESS INFORMATION -------------------------- 1. Licenses/restrictions placed on the data: # Copyright (c) 2015-2016, Particle Flux Analytics # All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met: # # 1. Redistributions of source code must retain the above copyright notice, this # list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the above copyright notice, # this list of conditions and the following disclaimer in the documentation # and/or other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # # The views and conclusions contained in the software and documentation are those # of the authors and should not be interpreted as representing official policies, # either expressed or implied, of the FreeBSD Project. 2. Links to publications that cite or use the data: None 3. Links to other publicly accessible locations of the data: None 4. Links/relationships to ancillary data sets: This code is used to process raw Multi-Angle Snowflake Camera (MASC) data retrieved from the U. S. Department of Energy (DOE) Atmospheric Radiation Measurement (ARM) data archive: https://www.arm.gov/data and http://dx.doi.org/10.5439/1234550. 5. Was data derived from another source? If yes, list source(s): This is a Python port of the masclab processing suite: https://github.com/Fall-tech/masclab. 6. Recommended citation for the data: Fitch, Kyle E. and Timothy J. Garrett. 2020. Mascpy code for "Graupel Precipitating from Thin Arctic Clouds with Liquid Water Paths less than 50 g m-2". The Hive: University of Utah Research Data Repository. --------------------- DATA & FILE OVERVIEW --------------------- 1. File List A. Folder Name: analysis Short description: this is the main folder from which the program is run; in particular, the file 'Standalone.py' calls all other subroutines and functions. The file 'defImgAnlParams.json' allows the user to specify parameters used to process input data. B. Folder Name: datatypes Short description: subroutine describing all parameters resulting from all images being analyzed for a particular particle; includes data from each image, as well as per-particle data C. Folder Name: fileio Short description: subroutine that writes out analyzed data in various formats D. Folder Name: imadjust Short description: subroutine that adjusts pixel intensity range of input image E. Folder Name: processing Short description: subroutine that performs the actual image analysis and particle analysis (i.e., image processing) F. Filename: read_me_updated.txt Short description: file containing instructions for running the program 2. Relationship between files: All files are used to run the program, but the primary file is analysis/Standalone.py 3. Additional related data collected that was not included in the current data package: Raw data are available at http://dx.doi.org/10.5439/1234550 Raw images from the ARM data archive are in the form oliMASCM1.a0.YYYYMMDD.HHMMSS.id_pppp_cam_n.png where pppp is the particle ID number and n is the camera number. Raw data files are in the form oliMASCM1.a0.YYYYMMDD.HH.raw_xxxxxx.xxx where xxxxxx.xxx is either config.xml, dataInfo.txt, imgInfo.txt, or statusLog.txt. 4. Are there multiple versions of the dataset? no If yes, list versions: Name of file that was updated: i. Why was the file updated? ii. When was the file updated? Name of file that was updated: i. Why was the file updated? ii. When was the file updated? -------------------------- METHODOLOGICAL INFORMATION -------------------------- 1. Description of methods used for collection/generation of data: The program processes the raw data according to the method documented in the DOE ARM Multi-Angle Snowflake Camera Particle Analysis Value-Added Product Technical Report provided and located at https://www.arm.gov/publications/tech_reports/doe-sc-arm-tr-187.pdf 2. Methods for processing the data: See #1 above 3. Instrument- or software-specific information needed to interpret the data: The technical specifications of the MASC are documented in the DOE ARM Multi-Angle Snowflake Camera Instrument Handbook provided and located at https://www.arm.gov/publications/tech_reports/handbooks/masc_handbook.pdf The mascpy program is run with Python 4. Standards and calibration information, if appropriate: See #3 above 5. Environmental/experimental conditions: Meteorological conditions vary by date and time and can be retrieved in a separate dataset on the ARM archive available at http://dx.doi.org/10.5439/1025220 6. Describe any quality-assurance procedures performed on the data: See #1 above 7. People involved with sample collection, processing, analysis and/or submission: The program was written by Konstantin Shkurko, assisted by Ahmad Talaei, Tim Garrett, and Krista Gaustad. ----------------------------------------- DATA-SPECIFIC INFORMATION FOR: [FILENAME] ----------------------------------------- 1. Number of variables: 2. Number of cases/rows: 3. Variable List A. Name: [variable name] Description: [description of the variable] Value labels if appropriate B. Name: [variable name] Description: [description of the variable] Value labels if appropriate 4. Missing data codes: Code/symbol Definition Code/symbol Definition 5. Specialized formats of other abbreviations used