style(release): Add an extra for installing mapping dependencies

.github/workflows/ci.yaml

@@ -24,6 +24,7 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements.txt
           pip install -r dev-requirements.txt
+          pip install -r mapping-requirements.txt
       - name: run tests
         run: python -m pytest --cov=. tests/
       - name: run test coverage

Dockerfile

@@ -24,12 +24,13 @@ COPY .git ${LIBRARYDIR}/.git
 COPY setup.py ${LIBRARYDIR}
 COPY setup.cfg ${LIBRARYDIR}
 COPY requirements.txt ${LIBRARYDIR}
+COPY mapping-requirements.txt ${LIBRARY_PATH}
 COPY README.md ${LIBRARYDIR}
 COPY LICENSE ${LIBRARYDIR}
 
 USER root
 RUN pip3 install --no-cache-dir setuptools wheel\
-    && pip3 install --no-cache-dir ${LIBRARYDIR} \
+    && pip3 install --no-cache-dir ${LIBRARYDIR}[mapping] \
     && apt-get -y --purge remove git \
     && apt-get -y clean \
     && apt-get -y autoremove \

README.md

@@ -17,6 +17,10 @@ Ladybug-comfort is a Python library that adds thermal comfort functionalities to
 
 `pip install ladybug-comfort`
 
+If you want to also include the dependencies needed for thermal mapping use:
+
+`pip install -U honeybee-energy[mapping]`
+
 To check if the Ladybug-comfort command line interface is installed correctly,
 use `ladybug-comfort --help`.
 

docs/index.rst

@@ -11,6 +11,12 @@ Installation
 
 ``pip install -U ladybug-comfort``
 
+If you want to also include the dependencies needed for thermal mapping use.
+
+``pip install -U honeybee-energy[mapping]``
+
+To check if the command line interface is installed correctly use ``ladybug-comfort --help``
+
 
 CLI Docs
 =============

ladybug_comfort/collection/adaptive.py

@@ -76,7 +76,7 @@ class Adaptive(ComfortCollection):
                  '_cooling_effect_coll')
 
     def __init__(self, outdoor_temperature, operative_temperature, air_speed=None,
-                 comfort_parameter=None): 
+                 comfort_parameter=None):
         """Initialize an Adaptive comfort object from DataCollections of inputs.
         """
         # set up the object using operative temperature as a base
@@ -133,7 +133,7 @@ def from_air_and_rad_temp(cls, outdoor_temperature, air_temperature,
         return cls(outdoor_temperature, to, air_speed, comfort_parameter)
 
     def _calculate_adaptive(self):
-        """Compute Adaptive comfort for each step of the Data Collection.""" 
+        """Compute Adaptive comfort for each step of the Data Collection."""
         # empty properties to be calculated
         self._neutral_temperature = []
         self._degrees_from_neutral = []
@@ -307,9 +307,9 @@ def __init__(self, outdoor_temperature, avg_month=True):
         self._head = self._t_out.header
         self._avg_month = avg_month
 
-        assert isinstance(self._head.data_type, Temperature) and self._head.unit == 'C',\
-            'outdoor_temperature must be Temperature in C. Got {} in {}'.format(
-                self._head.data_type, self._head.unit)
+        assert isinstance(self._head.data_type, Temperature) and \
+            self._head.unit == 'C', 'outdoor_temperature must be Temperature in C. ' \
+            'Got {} in {}'.format(self._head.data_type, self._head.unit)
         assert self._t_out.is_continuous, 'outdoor_temperature must be continuous.'
         assert self._head.analysis_period.is_annual, 'outdoor_temperature must be annual'
         assert isinstance(self._avg_month, bool), 'avg_month' \

mapping-requirements.txt

@@ -0,0 +1 @@
+numpy<2.0.0

setup.py

@@ -6,6 +6,9 @@
 with open('requirements.txt') as f:
     requirements = f.read().splitlines()
 
+with open('mapping-requirements.txt') as f:
+    mapping_requirements = f.read().splitlines()
+
 setuptools.setup(
     name="ladybug-comfort",
     use_scm_version=True,
@@ -20,6 +23,9 @@
     packages=setuptools.find_packages(exclude=['tests']),
     include_package_data=True,
     install_requires=requirements,
+    extras_require={
+        'mapping': mapping_requirements
+    },
     entry_points={
         "console_scripts": ["ladybug-comfort = ladybug_comfort.cli:comfort"]
     },