Explore the package

Go back to the list of notebooks

snowScatt is a modular package. The most important module is its internal database called snowLibrary that holds the informations about the snowflake shapes. snowScatt uses heavily inline docstrings as official documentation.

First, let’s import the package and call the help() function to see if snowScatt is installed correctly

import snowScatt
snowScatt.help()

This is the snwoScatt module.
 snowScatt loads the following modules and functions

 calcProperties, backscatter, backscatVel and snowMassVelocityArea are functions defined in the _compute submodule. Print their respective docstrings for further informations or navigate the online documentation

 snowLibrary is the main object loaded by the module
 to print a list of the available snow particle properties execute

 snowScatt.snowLibrary.info()

A basic description of the package should have appeared.

Next let’s call the snowScatt.snowLibrary.info() function to get a list of the snowLibrary content.

snowScatt.snowLibrary.info()

print the information content in the database

##  List of tabulated size resolved properties

Name:  Leinonen15tabA00
Table of Leinonen unrimed snowflakes
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_simultaneous_0.0.csv

Name:  Leinonen15tabB00
Table of Leinonen unrimed snowflakes
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_simultaneous_0.0.csv

Name:  Leinonen15tabA01
Table of Leinonen rimed snowflakes ELWP=0.1 model A simultaneous
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_simultaneous_0.1.csv

Name:  Leinonen15tabA02
Table of Leinonen rimed snowflakes ELWP=0.2 model A simultaneous
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_simultaneous_0.2.csv

Name:  Leinonen15tabA05
Table of Leinonen rimed snowflakes ELWP=0.5 model A simultaneous
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_simultaneous_0.5.csv

Name:  Leinonen15tabA10
Table of Leinonen rimed snowflakes ELWP=1.0 model A simultaneous
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_simultaneous_1.0.csv

Name:  Leinonen15tabA20
Table of Leinonen rimed snowflakes ELWP=2.0 model A simultaneous
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_simultaneous_2.0.csv

Name:  Leinonen15tabB01
Table of Leinonen rimed snowflakes ELWP=0.1 model B subsequent
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_subsequent_0.1.csv

Name:  Leinonen15tabB02
Table of Leinonen rimed snowflakes ELWP=0.2 model B subsequent
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_subsequent_0.2.csv

Name:  Leinonen15tabB05
Table of Leinonen rimed snowflakes ELWP=0.5 model B subsequent
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_subsequent_0.5.csv

Name:  Leinonen15tabB10
Table of Leinonen rimed snowflakes ELWP=1.0 model B subsequent
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_subsequent_1.0.csv

Name:  Leinonen15tabB20
Table of Leinonen rimed snowflakes ELWP=2.0 model B subsequent
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_subsequent_2.0.csv

Name:  Leinonen15tabC
Table of Leinonen rime only graupel
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_rimec.csv

Name:  vonTerzi_dendrite
Table of von Terzi assemblages of dendrites
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_dendrite.csv

Name:  vonTerzi_column
Table of von Terzi assemblages of columns
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_column.csv

Name:  vonTerzi_plate
Table of von Terzi assemblages of plates
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_plate.csv

Name:  vonTerzi_needle
Table of von Terzi assemblages of needles
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_needle.csv

Name:  vonTerzi_mixcoldend
Table of von Terzi assemblages of mixtures of columns and dendrites
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend.csv

Name:  vonTerzi_mixcoldend_rimed01
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.1
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.1.csv

Name:  vonTerzi_mixcoldend_rimed02
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.2
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.2.csv

Name:  vonTerzi_mixcoldend_rimed03
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.3
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.3.csv

Name:  vonTerzi_mixcoldend_rimed04
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.4
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.4.csv

Name:  vonTerzi_mixcoldend_rimed05
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.5
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.5.csv

Name:  vonTerzi_mixcoldend_rimed06
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.6
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.6.csv

Name:  vonTerzi_mixcoldend_rimed07
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.7
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.7.csv

Name:  vonTerzi_mixcoldend_rimed08
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.8
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.8.csv

Name:  vonTerzi_mixcoldend_rimed09
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 0.9
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_0.9.csv

Name:  vonTerzi_mixcoldend_rimed10
Table of von Terzi assemblages of mixtures of columns and dendrites with rimeelwp 1.0
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_mixcolumndend_rimed_1.0.csv

Name:  Ori_collColumns
Table of Davide Ori aggregates of collection of columns
Filepath : /home/dori/.local/lib/python3.8/site-packages/snowScatt/snowProperties/ssrga_coeffs_Ori_collection_columns.csv



######################################
This is the content of tables sections of the database
You can pass the argument section=["all", "avg", "tables"] to restrict the output to a certain section

The tables listed are all available in the snowScatt package. The “name” property is the label required to call tell snowScatt which particle type you wish to use. The property path lists on your machine the location of the text file that stores the snowTable properties. Go back to the list of notebooks to see how to use the package for some snow studies.