Skip to content

Allows reading TMY data from a Path or file-like object #2544

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
kandersolar merged 5 commits into from
Sep 18, 2025
Merged

Allows reading TMY data from a Path or file-like object #2544

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a110a69
Allows reading TMY data from a Path or file-like object
jerluc Sep 10, 2025
6561ccb
Reverts "filename" parameter rename for consistency
jerluc Sep 11, 2025
be82a62
Fixes linter issue in tests
jerluc Sep 11, 2025
8181548
Updates "What's New" docs for change
jerluc Sep 11, 2025
970688e
Adding a couple of more assertions for TMY3 parsing test
jerluc Sep 15, 2025
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
8 changes: 5 additions & 3 deletions pvlib/iotools/tmy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
import re
import pandas as pd

from pvlib.tools import _file_context_manager

# Dictionary mapping TMY3 names to pvlib names
VARIABLE_MAP = {
'GHI (W/m^2)': 'ghi',
Expand All @@ -22,7 +24,7 @@
}


def read_tmy3(filename, coerce_year=None, map_variables=True, encoding=None):
def read_tmy3(filename_or_obj, coerce_year=None, map_variables=True, encoding=None):

Check failure on line 27 in pvlib/iotools/tmy.py

View workflow job for this annotation

GitHub Actions / flake8-linter 

E501 line too long (84 > 79 characters)
"""Read a TMY3 file into a pandas dataframe.
Note that values contained in the metadata dictionary are unchanged
Expand All @@ -35,7 +37,7 @@
Parameters
----------
filename : str
filename_or_obj : str, Path, or file-like object
A relative file path or absolute file path.
coerce_year : int, optional
If supplied, the year of the index will be set to ``coerce_year``, except
Expand Down Expand Up @@ -186,7 +188,7 @@
""" # noqa: E501
head = ['USAF', 'Name', 'State', 'TZ', 'latitude', 'longitude', 'altitude']

with open(str(filename), 'r', encoding=encoding) as fbuf:
with _file_context_manager(filename_or_obj, mode="r", encoding=encoding) as fbuf:

Check failure on line 191 in pvlib/iotools/tmy.py

View workflow job for this annotation

GitHub Actions / flake8-linter 

E501 line too long (85 > 79 characters)
# header information on the 1st line (0 indexing)
firstline = fbuf.readline()
# use pandas to read the csv file buffer
Expand Down
4 changes: 2 additions & 2 deletions pvlib/tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ def normalize_max2one(a):
return res


def _file_context_manager(filename_or_object, mode='r'):
def _file_context_manager(filename_or_object, mode='r', encoding=None):
"""
Open a filename/path for reading, or pass a file-like object
through unchanged.
Expand All @@ -584,5 +584,5 @@ def _file_context_manager(filename_or_object, mode='r'):
context = contextlib.nullcontext(filename_or_object)
else:
# otherwise, assume a filename or path
context = open(str(filename_or_object), mode=mode)
context = open(str(filename_or_object), mode=mode, encoding=encoding)
return context
4 changes: 4 additions & 0 deletions tests/iotools/test_tmy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
def test_read_tmy3():
tmy.read_tmy3(TMY3_TESTFILE, map_variables=False)

def test_read_tmy3_buffer():

Check failure on line 21 in tests/iotools/test_tmy.py

View workflow job for this annotation

GitHub Actions / flake8-linter 

E302 expected 2 blank lines, found 1
with open(TMY3_TESTFILE) as f:
tmy.read_tmy3(f, map_variables=False)
Copy link
Member

@AdamRJensen AdamRJensen Sep 15, 2025

Choose a reason for hiding this comment

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

Suggested change
tmy.read_tmy3(f, map_variables=False)
tmy.read_tmy3(f, map_variables=False)
assert 'GHI source' in data.columns

I suggest adding a simple assertion to make sure that the dataframe actually contains something.

Copy link
Contributor Author

@jerluc jerluc Sep 15, 2025

Choose a reason for hiding this comment

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

Thanks for the suggestion @AdamRJensen (maybe I should've read the test just below 😆). I've added it in 970688e, in addition to a check for the parsed data being 8760 rows, which I believe is correct for TMY3.



def test_read_tmy3_norecolumn():
data, _ = tmy.read_tmy3(TMY3_TESTFILE, map_variables=False)
Expand Down
Loading