Package atmopy :: Package io :: Module source
[show private | hide private]
[frames | no frames]

Module atmopy.io.source

Classes
Source Stores information about a point source

Function Summary
  get_level_sources_coordinates(config_file, levels)
Loads sources coordinates from a configuration file, sorted by vertical level.
  get_sources_coordinates(config_file)
Loads sources coordinates from a configuration file.
  get_species_sources_coordinates(config_file, species, min_rate)
Loads sources coordinates from a configuration file, for sources emitting a given species.
  read_sources(config_file)
Loads sources attributes from a configuration file.

Function Details

get_level_sources_coordinates(config_file, levels)

Loads sources coordinates from a configuration file, sorted by vertical level.
Parameters:
config_file - The configuration file in which source attributes are to be found.
           (type=string)
levels - The list of vertical level interfaces.
           (type=list)
Returns:
The lists of (list of) abscissa and ordinates of all sources, sorted by level.

get_sources_coordinates(config_file)

Loads sources coordinates from a configuration file.
Parameters:
config_file - The configuration file in which source attributes are to be found.
           (type=string)
Returns:
The lists of abscissa and ordinates of all sources.

get_species_sources_coordinates(config_file, species, min_rate=0.0)

Loads sources coordinates from a configuration file, for sources emitting a given species.
Parameters:
config_file - The configuration file in which source attributes are to be found.
           (type=string)
species - The species name.
           (type=string)
min_rate - the minimal rate to be considered for the species.
           (type=float)
Returns:
The lists of abscissa and ordinates of all sources emitting the species 'species' with a higher rate than 'min_rate'.

read_sources(config_file)

Loads sources attributes from a configuration file.
Parameters:
config_file - The configuration file in which source attributes are to be found.
           (type=string)
Returns:
The list of sources.

Generated by Epydoc 2.1 on Tue May 19 10:37:12 2009 http://epydoc.sf.net