fix(map): Add binary option to several functions (#65)

* fix(map): Add binary option to several functions

* ci(ci): Update semantic release to avoid secondary rate limit

* docs(map): Describe main difference between plain text and binary

* refactor(map): Change input name from plain_text to output_format

.github/workflows/ci.yaml

@@ -17,7 +17,7 @@ jobs:
       - name: set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.7
+          python-version: '3.10'
       - name: install python dependencies
         run: |
           pip install -r dev-requirements.txt
@@ -37,9 +37,9 @@ jobs:
         with:
           python-version: 3.7
       - name: set up node  # we need node for for semantic release
-        uses: actions/setup-node@v2.1.2
+        uses: actions/setup-node@v4
         with:
-          node-version: 14.2.0
+          node-version: 22.2.0
       - name: install python dependencies
         run: |
           pip install -r dev-requirements.txt
@@ -50,8 +50,8 @@ jobs:
       - name: run semantic release
         id: new_release
         run: |
-          nextRelease="`npx semantic-release@^17.0.0 --dryRun | grep -oP 'Published release \K.*? ' || true`"
-          npx semantic-release@^17.0.0
+          nextRelease="`npx semantic-release@^23.1.1 --dryRun | grep -oP 'Published release \K.*? ' || true`"
+          npx semantic-release@^23.1.1
           echo "::set-output name=tag::$nextRelease"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

dev-requirements.txt

@@ -1,4 +1,4 @@
-pytest==6.2.3
+pytest==6.2.5
 twine==3.4.1
 wheel==0.36.2
 setuptools==56.0.0

pollination/ladybug_comfort/map.py

@@ -291,14 +291,24 @@ class UtciMap(Function):
         'will be for the entire result_sql run period.', default=''
     )
 
+    output_format = 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. 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
     def run_utci_map(self):
         return 'ladybug-comfort map utci result.sql enclosure_info.json ' \
             'weather.epw --total-irradiance total.ill --direct-irradiance direct.ill ' \
             '--ref-irradiance ref.ill --sun-up-hours sun-up-hours.txt ' \
             '--wind-speed "{{self.wind_speed}}" --solarcal-par ' \
             '"{{self.solarcal_par}}" --comfort-par "{{self.comfort_par}}" ' \
-            '--run-period "{{self.run_period}}" --folder output'
+            '--run-period "{{self.run_period}}" --{{self.output_format}} --folder output'
 
     result_folder = Outputs.folder(
         description='Folder containing all of the output CSV files.', path='output'
@@ -464,14 +474,24 @@ class ShortwaveMrtMap(Function):
         spec={'type': 'string', 'enum': ['is-indirect', 'indirect-is-total']}
     )
 
+    output_format = 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. 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
     def run_shortwave_map(self):
         return 'ladybug-comfort map shortwave-mrt weather.epw indirect.ill direct.ill ' \
             'ref.ill sun-up-hours.txt --contributions dynamic ' \
             '--transmittance-contribs dyn_shade --trans-schedule-json ' \
             'trans_schedules.json --solarcal-par "{{self.solarcal_par}}" ' \
             '--run-period "{{self.run_period}}" --{{self.indirect_is_total}} ' \
-            '--output-file shortwave.csv'
+            '--{{self.output_format}} --output-file shortwave.csv'
 
     shortwave_mrt_map = Outputs.file(
         description='CSV file containing a map of shortwave MRT deltas.',
@@ -516,11 +536,22 @@ class LongwaveMrtMap(Function):
         'will be annual.', default=''
     )
 
+    output_format = 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. 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
     def run_longwave_map(self):
         return 'ladybug-comfort map longwave-mrt result.sql view_factors.csv ' \
             'view_factors.mod enclosure_info.json weather.epw ' \
-            '--run-period "{{self.run_period}}" --output-file longwave.csv'
+            '--run-period "{{self.run_period}}" --{{self.output_format}} ' \
+            '--output-file longwave.csv'
 
     longwave_mrt_map = Outputs.file(
         description='CSV file containing a map of longwave MRT.',
@@ -563,11 +594,21 @@ class AirMap(Function):
         spec={'type': 'string', 'enum': ['air-temperature', 'relative-humidity']}
     )
 
+    output_format = 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. 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
     def run_air_map(self):
         return 'ladybug-comfort map air result.sql enclosure_info.json weather.epw ' \
             '--run-period "{{self.run_period}}" --{{self.metric}} ' \
-            '--output-file air.csv'
+            '--{{self.output_format}} --output-file air.csv'
 
     air_map = Outputs.file(
         description='CSV file containing a map of air temperatures or humidity.',

pollination/ladybug_comfort/mtx.py

@@ -206,12 +206,23 @@ class UtciMtx(Function):
         'the UTCI comfort model.', default='--cold 9 --heat 26'
     )
 
+    output_format = 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. 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
     def run_utci_mtx(self):
         return 'ladybug-comfort mtx utci air_temperature.csv rel_humidity.csv ' \
             '--rad-temperature-mtx rad_temperature.csv --rad-delta-mtx rad_delta.csv ' \
             '--wind-speed-json wind_speed.json --air-speed-mtx air_speed.csv ' \
-            '--comfort-par "{{self.comfort_par}}" --folder output'
+            '--comfort-par "{{self.comfort_par}}" --{{self.output_format}} ' \
+            '--folder output'
 
     result_folder = Outputs.folder(
         description='Folder containing all of the output CSV files.', path='output'