Skip to content

Commit

Permalink
docs(map): Describe main difference between plain text and binary
Browse files Browse the repository at this point in the history
  • Loading branch information
mikkelkp committed Jul 28, 2024
1 parent 9675d19 commit 639da8b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
20 changes: 16 additions & 4 deletions pollination/ladybug_comfort/map.py
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,10 @@ class UtciMap(Function):
plain_text = Inputs.str(
description='Flag to note whether the output should be formatted as a '
'plain text CSV or whether it should be formatted as a binary numpy '
'array.', default='plain-text',
'array. Using binary will decrease the file size, however, to read the '
'contents of the file you have to pass it through numpy, whereas the '
'plain text file can be opened in a text editor.',
default='plain-text',
spec={'type': 'string', 'enum': ['plain-text', 'binary']}
)

Expand Down Expand Up @@ -474,7 +477,10 @@ class ShortwaveMrtMap(Function):
plain_text = Inputs.str(
description='Flag to note whether the output should be formatted as a '
'plain text CSV or whether it should be formatted as a binary numpy '
'array.', default='plain-text',
'array. Using binary will decrease the file size, however, to read the '
'contents of the file you have to pass it through numpy, whereas the '
'plain text file can be opened in a text editor.',
default='plain-text',
spec={'type': 'string', 'enum': ['plain-text', 'binary']}
)

Expand Down Expand Up @@ -533,7 +539,10 @@ class LongwaveMrtMap(Function):
plain_text = Inputs.str(
description='Flag to note whether the output should be formatted as a '
'plain text CSV or whether it should be formatted as a binary numpy '
'array.', default='plain-text',
'array. Using binary will decrease the file size, however, to read the '
'contents of the file you have to pass it through numpy, whereas the '
'plain text file can be opened in a text editor.',
default='plain-text',
spec={'type': 'string', 'enum': ['plain-text', 'binary']}
)

Expand Down Expand Up @@ -588,7 +597,10 @@ class AirMap(Function):
plain_text = Inputs.str(
description='Flag to note whether the output should be formatted as a '
'plain text CSV or whether it should be formatted as a binary numpy '
'array.', default='plain-text',
'array. Using binary will decrease the file size, however, to read the '
'contents of the file you have to pass it through numpy, whereas the '
'plain text file can be opened in a text editor.',
default='plain-text',
spec={'type': 'string', 'enum': ['plain-text', 'binary']}
)

Expand Down
8 changes: 5 additions & 3 deletions pollination/ladybug_comfort/mtx.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,11 @@ class UtciMtx(Function):
plain_text = Inputs.str(
description='Flag to note whether the output should be formatted as a '
'plain text CSV or whether it should be formatted as a binary numpy '
'array.', default='plain-text',
spec={'type': 'string',
'enum': ['plain-text', 'binary']}
'array. Using binary will decrease the file size, however, to read the '
'contents of the file you have to pass it through numpy, whereas the '
'plain text file can be opened in a text editor.',
default='plain-text',
spec={'type': 'string', 'enum': ['plain-text', 'binary']}
)

@command
Expand Down

0 comments on commit 639da8b

Please sign in to comment.