FireSTARR
Loading...
Searching...
No Matches
util Namespace Reference

Functions

 is_sequential_days (data)
 Determine if data is sequential days.
 
 is_sequential_hours (data)
 Determine if data is sequential hours.
 
 find_q (temp, rh)
 Find specific humidity.
 
 find_rh (q, temp)
 Find relative humidity.
 
 julian (mon, day)
 Find day of year.
 
 sun (lat, lon, mon, day, hour, timezone)
 Find solar radiation at a give time and place.
 
 seasonal_curing (julian_date)
 
 save_csv (df, file)
 
 ensure_dir (dir)
 
 try_remove (file)
 
 find_files (folder, file_mask=' *')
 
 fix_timezone_offset (d)
 
 save_http (to_dir, url, save_as=None, mode='wb', ignore_existing=False)
 
 save_ftp (to_dir, url, user="anonymous", password="")
 

Variables

 _create_default_https_context
 So HTTPS transfers work properly.
 

Detailed Description

Helper functions

Function Documentation

◆ ensure_dir()

util.ensure_dir ( dir)
Make sure directory exists

◆ find_files()

util.find_files ( folder,
file_mask = '*' )
Find all files matching mask recursively in folder

◆ find_q()

util.find_q ( temp,
rh )

Find specific humidity.

Parameters
tempTemperature (Celcius)
rhRelative humidity (percent, 0-100)
Returns
Specific humidity (g/kg)

◆ find_rh()

util.find_rh ( q,
temp )

Find relative humidity.

Parameters
qSpecific humidity (g/kg)
tempTemperature (Celcius)
Returns
Relative humidity (percent, 0-100)

◆ fix_timezone_offset()

util.fix_timezone_offset ( d)
 Convert from UTC to local time, respecting DST if required 

◆ is_sequential_days()

util.is_sequential_days ( data)

Determine if data is sequential days.

Parameters
datadata to check
Returns
whether each entry is 1 day from the next entry

◆ is_sequential_hours()

util.is_sequential_hours ( data)

Determine if data is sequential hours.

Parameters
datadata to check
Returns
whether each entry is 1 hour from the next entry

◆ julian()

util.julian ( mon,
day )

Find day of year.

Does not properly deal with leap years.

Parameters
monMonth
dayDay of month
Returns
Day of year
Here is the caller graph for this function:

◆ save_ftp()

util.save_ftp ( to_dir,
url,
user = "anonymous",
password = "" )
 Save file at given URL into given directory using an FTP connection 

◆ save_http()

util.save_http ( to_dir,
url,
save_as = None,
mode = 'wb',
ignore_existing = False )
 Save file at given URL into given directory using an HTTP connection 

◆ sun()

util.sun ( lat,
lon,
mon,
day,
hour,
timezone )

Find solar radiation at a give time and place.

Parameters
latLatitude (degrees)
longLongitude (degrees)
monMonth (1-12)
dayDay of month
hourHour of day
timezoneOffset from GMT in hours
Returns
Solar radiation (kW/m^2), sunrise, sunset
Here is the call graph for this function:

◆ try_remove()

util.try_remove ( file)
Try to delete file but don't worry if it doesn't work