from ._pointintimesky import PointInTimeSky
from ..command.gensky import Gensky
from ladybug.location import Location
[docs]class CIE(PointInTimeSky):
"""Create Standard CIE sky.
Attributes:
location: A ladybug location
month: A number to indicate month (1..12)
day: A number to indicate day (1..31)
hour: A number to indicate hour (0..23)
north_: A number between 0 and 360 that represents the degrees off from
the y-axis to make North. The default North direction is set to the
Y-axis (default: 0 degrees).
sky_type: An integer between 0..5 to indicate CIE Sky Type.
[0] Sunny with sun, [1] sunny without sun, [2] intermediate with sun
[3] intermediate without sun, [4] cloudy sky, [5] uniform sky
suffix: An optional suffix for sky name. The suffix will be added at the
end of the standard name. Use this input to customize the new and
avoid sky being overwritten by other skymatrix components.
"""
SKYTYPES = {
0: ('+s', 'sunnyWSun'),
1: ('-s', 'sunnyNoSun'),
2: ('+i', 'intermWSun'),
3: ('-i', 'intermNoSun'),
4: ('-c', 'cloudy_sky'),
5: ('-u', 'uniformSky')
}
def __init__(self, location=None, month=9, day=21, hour=12, north=0, sky_type=0,
suffix=None):
"""Create CIE sky.
Args:
location: A ladybug location
month: A number to indicate month (1..12)
day: A number to indicate day (1..31)
hour: A number to indicate hour (0..23)
north_: A number between 0 and 360 that represents the degrees off from
the y-axis to make North. The default North direction is set to the
Y-axis (default: 0 degrees).
sky_type: An integer between 0..5 to indicate CIE Sky Type.
[0] Sunny with sun, [1] sunny without sun, [2] intermediate with sun
[3] intermediate without sun, [4] cloudy sky, [5] uniform sky
"""
PointInTimeSky.__init__(self, location, month, day, hour, north, suffix=suffix)
self.sky_type = sky_type % 6
self.humanReadableSkyType = self.SKYTYPES[self.sky_type][1]
[docs] @classmethod
def from_json(cls, loc_json):
"""Create sky form json.
{
"location": {}, // honeybee (or actually ladybug location schema)
"day": 1, // an integer between 1-31
"month": 1, // an integer between 1-12
"hour": 12.0, // a float number between 0-23
"north": 0, // degree for north if not Y axis
"sky_type": 0 // A number between 0-5 -- 0: sunny sky
}
location schema
{
"city": "",
"latitude": 0,
"longitude": 0,
"time_zone": 0,
"elevation": 0
}
"""
data = loc_json
location = Location.from_json(data["location"])
return cls(location, month=data["month"],
day=data["day"], hour=data["hour"], north=data["north"],
sky_type=data["sky_type"])
[docs] @classmethod
def from_lat_long(cls, city, latitude, longitude, timezone, elevation,
month=6, day=21, hour=9, north=0, sky_type=0, suffix=None):
"""Create sky from latitude and longitude."""
loc = Location(city, None, latitude, longitude, timezone, elevation)
return cls(loc, month, day, hour, sky_type, north, suffix=suffix)
@property
def name(self):
"""Sky default name."""
return "{}_{}_{}_{}_{}_{}_at_{}{}".format(
self.__class__.__name__,
self.humanReadableSkyType,
self.location.latitude,
self.location.longitude,
self.month, self.day, self.hour,
'_{}'.format(self.suffix) if self.suffix else ''
)
[docs] def command(self, folder=None):
"""Gensky command."""
if folder:
output_name = folder + '/' + self.name
else:
output_name = self.name
cmd = Gensky.from_sky_type(
output_name=output_name, month_day_hour=(self.month, self.day, self.hour),
sky_type=self.sky_type, latitude=self.location.latitude,
longitude=-1 * self.location.longitude, meridian=self.location.meridian,
rotation=self.north)
return cmd
[docs] def duplicate(self):
"""Duplicate class."""
return CIE(self.location, self.month, self.day, self.hour, self.north,
self.sky_type, self.suffix)
[docs] def ToString(self):
"""Overwrite .NET ToString method."""
return self.__repr__()
[docs] def to_json(self):
"""Return sky as a json.
{
"location": {}, // honeybee (or actually ladybug location schema)
"day": 1, // an integer between 1-31
"month": 1, // an integer between 1-12
"hour": 12.0, // a float number between 0-23
"north": 0, // degree for north if not Y axis
"sky_type": 0 // A number between 0-5 -- 0: sunny sky
}
location schema
{
"city": "",
"latitude": 0,
"longitude": 0,
"time_zone": 0,
"elevation": 0
}
"""
return {
"location": self.location.to_json(),
"day": self.day,
"month": self.month,
"hour": self.hour,
"north": self.north,
"sky_type": self.sky_type
}
def __repr__(self):
"""Sky representation."""
return self.to_rad_string()
