Skip to content

improve PVSystem and associated object reprs #1031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 25, 2020
Merged

improve PVSystem and associated object reprs #1031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b722700
add module_type and temp params
wholmgren Aug 25, 2020
2c7d2a5
reprs
wholmgren Aug 25, 2020
2b5526d
manually specify temp for py 3.5 order
wholmgren Aug 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/sphinx/source/whatsnew/v0.8.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ Enhancements
(:pull:`1017`)
* Add :py:func:`pvlib.inverter.fit_sandia` that fits the Sandia inverter model
to a set of inverter efficiency curves. (:pull:`1011`)
* Added *racking_model*, *module_type*, and *temperature_model_parameters* to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*racking_model* renders as italics on RTD. Doesn't matter to me, just fyi if those were supposed to be inline literals (double backticks).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I intended for them to be italics but can change them if someone cares. I think too many inline literals make the whats new extremely hard to read.

PVSystem, LocalizedPVSystem, SingleAxisTracker, and
LocalizedSingleAxisTracker repr methods. (:issue:`1027`)

Bug fixes
~~~~~~~~~
Expand Down
10 changes: 6 additions & 4 deletions pvlib/pvsystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,8 +238,9 @@ def __init__(self,

def __repr__(self):
attrs = ['name', 'surface_tilt', 'surface_azimuth', 'module',
'inverter', 'albedo', 'racking_model']
return ('PVSystem: \n ' + '\n '.join(
'inverter', 'albedo', 'racking_model', 'module_type',
'temperature_model_parameters']
return ('PVSystem:\n ' + '\n '.join(
('{}: {}'.format(attr, getattr(self, attr)) for attr in attrs)))

def get_aoi(self, solar_zenith, solar_azimuth):
Expand Down Expand Up @@ -898,8 +899,9 @@ def __init__(self, pvsystem=None, location=None, **kwargs):
def __repr__(self):
attrs = ['name', 'latitude', 'longitude', 'altitude', 'tz',
'surface_tilt', 'surface_azimuth', 'module', 'inverter',
'albedo', 'racking_model']
return ('LocalizedPVSystem: \n ' + '\n '.join(
'albedo', 'racking_model', 'module_type',
'temperature_model_parameters']
return ('LocalizedPVSystem:\n ' + '\n '.join(
('{}: {}'.format(attr, getattr(self, attr)) for attr in attrs)))


Expand Down
72 changes: 50 additions & 22 deletions pvlib/tests/test_pvsystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1119,23 +1119,43 @@ def test_PVSystem_localize_with_latlon():


def test_PVSystem___repr__():
system = pvsystem.PVSystem(module='blah', inverter='blarg', name='pv ftw')

expected = ('PVSystem: \n name: pv ftw\n surface_tilt: 0\n '
'surface_azimuth: 180\n module: blah\n inverter: blarg\n '
'albedo: 0.25\n racking_model: open_rack')

system = pvsystem.PVSystem(
module='blah', inverter='blarg', name='pv ftw',
temperature_model_parameters={'a': -3.56})

expected = """PVSystem:
name: pv ftw
surface_tilt: 0
surface_azimuth: 180
module: blah
inverter: blarg
albedo: 0.25
racking_model: open_rack
module_type: glass_polymer
temperature_model_parameters: {'a': -3.56}"""
assert system.__repr__() == expected


def test_PVSystem_localize___repr__():
system = pvsystem.PVSystem(module='blah', inverter='blarg', name='pv ftw')
system = pvsystem.PVSystem(
module='blah', inverter='blarg', name='pv ftw',
temperature_model_parameters={'a': -3.56})
localized_system = system.localize(latitude=32, longitude=-111)

expected = ('LocalizedPVSystem: \n name: None\n latitude: 32\n '
'longitude: -111\n altitude: 0\n tz: UTC\n '
'surface_tilt: 0\n surface_azimuth: 180\n module: blah\n '
'inverter: blarg\n albedo: 0.25\n racking_model: open_rack')
# apparently name is not preserved when creating a system using localize
expected = """LocalizedPVSystem:
name: None
latitude: 32
longitude: -111
altitude: 0
tz: UTC
surface_tilt: 0
surface_azimuth: 180
module: blah
inverter: blarg
albedo: 0.25
racking_model: open_rack
module_type: glass_polymer
temperature_model_parameters: {'a': -3.56}"""

assert localized_system.__repr__() == expected

Expand All @@ -1158,16 +1178,24 @@ def test_LocalizedPVSystem_creation():


def test_LocalizedPVSystem___repr__():
localized_system = pvsystem.LocalizedPVSystem(latitude=32,
longitude=-111,
module='blah',
inverter='blarg',
name='my name')

expected = ('LocalizedPVSystem: \n name: my name\n latitude: 32\n '
'longitude: -111\n altitude: 0\n tz: UTC\n '
'surface_tilt: 0\n surface_azimuth: 180\n module: blah\n '
'inverter: blarg\n albedo: 0.25\n racking_model: open_rack')
localized_system = pvsystem.LocalizedPVSystem(
latitude=32, longitude=-111, module='blah', inverter='blarg',
name='my name', temperature_model_parameters={'a': -3.56})

expected = """LocalizedPVSystem:
name: my name
latitude: 32
longitude: -111
altitude: 0
tz: UTC
surface_tilt: 0
surface_azimuth: 180
module: blah
inverter: blarg
albedo: 0.25
racking_model: open_rack
module_type: glass_polymer
temperature_model_parameters: {'a': -3.56}"""

assert localized_system.__repr__() == expected

Expand Down
61 changes: 42 additions & 19 deletions pvlib/tests/test_tracking.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,28 +438,51 @@ def test_get_irradiance():


def test_SingleAxisTracker___repr__():
system = tracking.SingleAxisTracker(max_angle=45, gcr=.25,
module='blah', inverter='blarg')
expected = ('SingleAxisTracker: \n axis_tilt: 0\n axis_azimuth: 0\n '
'max_angle: 45\n backtrack: True\n gcr: 0.25\n '
'name: None\n surface_tilt: None\n surface_azimuth: None\n '
'module: blah\n inverter: blarg\n albedo: 0.25\n '
'racking_model: open_rack')
system = tracking.SingleAxisTracker(
max_angle=45, gcr=.25, module='blah', inverter='blarg',
temperature_model_parameters={'a': -3.56})
expected = """SingleAxisTracker:
axis_tilt: 0
axis_azimuth: 0
max_angle: 45
backtrack: True
gcr: 0.25
name: None
surface_tilt: None
surface_azimuth: None
module: blah
inverter: blarg
albedo: 0.25
racking_model: open_rack
module_type: glass_polymer
temperature_model_parameters: {'a': -3.56}"""
assert system.__repr__() == expected


def test_LocalizedSingleAxisTracker___repr__():
localized_system = tracking.LocalizedSingleAxisTracker(latitude=32,
longitude=-111,
module='blah',
inverter='blarg',
gcr=0.25)

expected = ('LocalizedSingleAxisTracker: \n axis_tilt: 0\n '
'axis_azimuth: 0\n max_angle: 90\n backtrack: True\n '
'gcr: 0.25\n name: None\n surface_tilt: None\n '
'surface_azimuth: None\n module: blah\n inverter: blarg\n '
'albedo: 0.25\n racking_model: open_rack\n '
'latitude: 32\n longitude: -111\n altitude: 0\n tz: UTC')
localized_system = tracking.LocalizedSingleAxisTracker(
latitude=32, longitude=-111, module='blah', inverter='blarg',
gcr=0.25, temperature_model_parameters={'a': -3.56})
# apparently the repr order is different for LocalizedSingleAxisTracker
# than for LocalizedPVSystem. maybe a MRO thing.
expected = """LocalizedSingleAxisTracker:
axis_tilt: 0
axis_azimuth: 0
max_angle: 90
backtrack: True
gcr: 0.25
name: None
surface_tilt: None
surface_azimuth: None
module: blah
inverter: blarg
albedo: 0.25
racking_model: open_rack
module_type: glass_polymer
temperature_model_parameters: {'a': -3.56}
latitude: 32
longitude: -111
altitude: 0
tz: UTC"""

assert localized_system.__repr__() == expected
2 changes: 1 addition & 1 deletion pvlib/tracking.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def __init__(self, axis_tilt=0, axis_azimuth=0,

def __repr__(self):
attrs = ['axis_tilt', 'axis_azimuth', 'max_angle', 'backtrack', 'gcr']
sat_repr = ('SingleAxisTracker: \n ' + '\n '.join(
sat_repr = ('SingleAxisTracker:\n ' + '\n '.join(
('{}: {}'.format(attr, getattr(self, attr)) for attr in attrs)))
# get the parent PVSystem info
pvsystem_repr = super(SingleAxisTracker, self).__repr__()
Expand Down