mango 0.2.1__tar.gz → 0.2.2__tar.gz

{mango-0.2.1/mango.egg-info → mango-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mango
-Version: 0.2.1
+Version: 0.2.2
 Summary: Library with a collection of usefull classes and methods to DRY
 Author-email: baobab soluciones <mango@baobabsoluciones.es>
 License: Apache Software License
@@ -54,6 +54,19 @@ Requires-Dist: shap[plots]==0.43.0; extra == "shap"
 Mango
 ------
 
+.. image:: https://img.shields.io/pypi/v/mango?label=version&logo=python&logoColor=white&style=for-the-badge&color=E58164
+   :alt: PyPI
+   :target: https://pypi.python.org/pypi/cornflow-client
+.. image:: https://img.shields.io/pypi/l/mango?color=blue&style=for-the-badge
+  :alt: PyPI - License
+  :target: https://github.com/baobabsoluciones/cornflow/blob/master/LICENSE
+.. image:: https://img.shields.io/github/actions/workflow/status/baobabsoluciones/mango/build_docs.yml?label=docs&logo=github&style=for-the-badge
+   :alt: GitHub Workflow Status
+   :target: https://github.com/baobabsoluciones/cornflow/actions
+.. image:: https://img.shields.io/codecov/c/gh/baobabsoluciones/mango?flag=unit-tests&label=coverage&logo=codecov&logoColor=white&style=for-the-badge&token=0KKRF3J95L
+    :alt: Codecov
+    :target: https://app.codecov.io/gh/baobabsoluciones/mango
+
 This a library containing several modules developed by the team at baobab soluciones. These functions, classes and methods are based on their experience, understanding and knowledge of the Python language and its ecosystem.
 
 The functions are divided in different modules so even though everything is imported the dependencies can be installed only for the modules that are needed.

mango-0.2.2/README.rst

@@ -0,0 +1,19 @@
+Mango
+------
+
+.. image:: https://img.shields.io/pypi/v/mango?label=version&logo=python&logoColor=white&style=for-the-badge&color=E58164
+   :alt: PyPI
+   :target: https://pypi.python.org/pypi/cornflow-client
+.. image:: https://img.shields.io/pypi/l/mango?color=blue&style=for-the-badge
+  :alt: PyPI - License
+  :target: https://github.com/baobabsoluciones/cornflow/blob/master/LICENSE
+.. image:: https://img.shields.io/github/actions/workflow/status/baobabsoluciones/mango/build_docs.yml?label=docs&logo=github&style=for-the-badge
+   :alt: GitHub Workflow Status
+   :target: https://github.com/baobabsoluciones/cornflow/actions
+.. image:: https://img.shields.io/codecov/c/gh/baobabsoluciones/mango?flag=unit-tests&label=coverage&logo=codecov&logoColor=white&style=for-the-badge&token=0KKRF3J95L
+    :alt: Codecov
+    :target: https://app.codecov.io/gh/baobabsoluciones/mango
+
+This a library containing several modules developed by the team at baobab soluciones. These functions, classes and methods are based on their experience, understanding and knowledge of the Python language and its ecosystem.
+
+The functions are divided in different modules so even though everything is imported the dependencies can be installed only for the modules that are needed.

mango-0.2.2/mango/__init__.py

@@ -0,0 +1,4 @@
+"""
+Main file
+"""
+__version__ = "0.2.2"

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/gramacy_lee.py

@@ -1,26 +1,33 @@
 from math import sin, pi
+from typing import Union
 
+import numpy as np
 
-def gramacy_lee(x: list) -> float:
+
+def gramacy_lee(x: Union[np.array, list, float]) -> float:
     """
     Gramacy & Lee function.
 
     This function is multimodal, with a number of local minima. The global minimum is at x = 0.54.
 
-    :param list x: list of floats. Each value is usually between -0.5 and 2.5.
+    :param x: array or list with the value or the value itself. Each value is usually between -0.5 and 2.5.
+    :type x: :class:`numpy.array`, list or float
     :return: the value of the function
     :rtype: float
     """
+    if isinstance(x, float):
+        x = [x]
     return sin(10 * pi * x[0]) / (2 * x[0]) + (x[0] - 1) ** 4
 
 
-def inverted_gramacy_lee(x: list) -> float:
+def inverted_gramacy_lee(x: Union[np.array, list, float]) -> float:
     """
     Inverted Gramacy & Lee function.
 
     This function is multimodal, with a number of local minima. The global minimum is at x = 0.54.
 
-    :param list x: list of floats. Each value is usually between -0.5 and 2.5.
+    :param x: array or list with the value or the value itself. Each value is usually between -0.5 and 2.5.
+    :type x: :class:`numpy.array`, list or float
     :return: the value of the function
     :rtype: float
     """

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/griewank.py

@@ -1,5 +1,3 @@
-from math import prod, cos, sqrt
-
 import numpy as np
 
 
@@ -9,6 +7,8 @@ def griewank(x: np.array) -> float:
 
     The Griewank function has many widespread local minima, which are regularly distributed
 
+    The global minima is located at [0, 0, ..., 0] with a value of 0
+
     :param x: array of floats
     :type x: :class:`numpy.ndarray`
     :return: the value of the function

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/holder_table.py

@@ -1,7 +1,10 @@
 from math import sin, cos, exp, sqrt, pi
+from typing import Union
 
+import numpy as np
 
-def holder_table(x: list) -> float:
+
+def holder_table(x: Union[np.array, list]) -> float:
     """
     Holder function.
 
@@ -9,14 +12,15 @@ def holder_table(x: list) -> float:
     The global minima is at (8.05502, 9.66459), (-8.05502, 9.66459), (8.05502, -9.66459) and (-8.05502, -9.66459)
     with a value of -19.2085.
 
-    :param list x: list of floats. Each value is usually between -10 and 10.
+    :param x: array or list of floats. Each value is usually between -10 and 10.
+    :type x: :class:`numpy.array` or list
     :return: the value of the function
     :rtype: float
     """
     return -abs(sin(x[0]) * cos(x[1]) * exp(abs(1 - sqrt(x[0] ** 2 + x[1] ** 2) / pi)))
 
 
-def inverted_holder_table(x: list) -> float:
+def inverted_holder_table(x: Union[np.array, list]) -> float:
     """
     Inverted Holder function.
 
@@ -26,7 +30,8 @@ def inverted_holder_table(x: list) -> float:
     The global maxima is at (8.05502, 9.66459), (-8.05502, 9.66459), (8.05502, -9.66459) and (-8.05502, -9.66459)
     with a value of 19.2085.
 
-    :param list x: list of floats. Each value is usually between -10 and 10.
+    :param x: list of floats. Each value is usually between -10 and 10.
+    :type x: :class:`numpy.array` or list
     :return: the value of the function
     :rtype: float
     """

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/langermann.py

@@ -1,14 +1,21 @@
 from math import exp, pi, cos
+from typing import Union
 
+import numpy as np
 
-def langermann(x: list) -> float:
+
+def langermann(x: Union[np.array, list]) -> float:
     """
     Langermann function.
 
     The Langermann function is a multimodal problem. It has a fairly large number of local minima,
     widely separated and regularly distributed.
 
-    :param list x: list of floats. Each value is usually between 0 and 10.
+    This implementation is only for the two dimension version of the function using the values for a, c and m
+    proposed by Molga & Smutnicki (2005) :cite:p:`molga2005test`.
+
+    :param x: array or list of floats. Each value is usually between 0 and 10.
+    :type x: :class:`numpy.array` or list
     :return: the value of the function
     :rtype: float
     """
@@ -29,14 +36,15 @@ def langermann(x: list) -> float:
     )
 
 
-def inverted_langermann(x: list) -> float:
+def inverted_langermann(x: Union[np.array, list]) -> float:
     """
     Inverted Langermann function.
 
     The Langermann function is a multimodal problem. It has a fairly large number of local minima,
     widely separated and regularly distributed. This implementation inverts the function to test out the maximization
 
-    :param list x: list of floats. Each value is usually between 0 and 10.
+    :param x: array or list of floats. Each value is usually between 0 and 10.
+    :type x: :class:`numpy.array` or list
     :return: the value of the function
     :rtype: float
     """

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/levy.py

@@ -1,4 +1,5 @@
 from math import sin, pi
+from typing import Union
 
 import numpy as np
 
@@ -9,7 +10,8 @@ def levy(x: np.array) -> float:
 
     The global minima is at x = [1, 1, 1, ..., 1] and the function value is 0.
 
-    :param :class:`np.array` x: array of floats. Each value is usually between -10 and 10.
+    :param x: array of floats. Each value is usually between -10 and 10.
+    :type x: :class:`numpy.array`
     :return: the value of the function
     :rtype: float
     """
@@ -26,20 +28,22 @@ def inverted_levy(x: np.array) -> float:
     """
     Inverted Levy function.
 
-    :param :class:`np.array` x: array of floats. Each value is usually between -10 and 10.
+    :param x: array of floats. Each value is usually between -10 and 10.
+    :type x: :class:`numpy.array`
     :return: the value of the function
     :rtype: float
     """
     return -levy(x)
 
 
-def levy_function_no13(x: list) -> float:
+def levy_function_no13(x: Union[np.array, list]) -> float:
     """
     Levy function N. 13.
 
     The global minima is at x = [1, 1] and the function value is 0.
 
-    :param list x: list of floats. Each value is usually between -10 and 10.
+    :param x: array or list of floats. Each value is usually between -10 and 10.
+    :type x: :class:`numpy.array` or list
     :return: the value of the function
     :rtype: float
     :doc-author: baobab soluciones
@@ -51,13 +55,14 @@ def levy_function_no13(x: list) -> float:
     )
 
 
-def inverted_levy_no13(x: list) -> float:
+def inverted_levy_no13(x: Union[np.array, list]) -> float:
     """
     Inverted Levy function N. 13.
 
     The global minima is at x = [1, 1] and the function value is 0.
 
-    :param list x: list of floats. Each value is usually between -10 and 10.
+    :param x: list of floats. Each value is usually between -10 and 10.
+    :type x: :class:`numpy.array` or list
     :return: the value of the function
     :rtype: float
     :doc-author: baobab soluciones

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/rastrigin.py

@@ -1,28 +1,34 @@
 from math import cos, pi
 
+import numpy as np
 
-def rastrigin(x: list) -> float:
+
+def rastrigin(x: np.array) -> float:
     """
     Rastrigin function.
 
     The Rastrigin function has several local minima. It is highly multimodal, but locations of the minima
     are regularly distributed.
 
-    :param list x: list of floats. Values usually are between -5.12 and 5.12.
+    The global minima is at [0, 0, ..., 0] with a value of 0
+
+    :param x: array of floats. Values usually are between -5.12 and 5.12.
+    :type x: :class:`npumpy.array`
     :return: the value of the function
     :rtype: float
     """
-    return 10 * len(x) + sum([i**2 - 10 * cos(2 * pi * i) for i in x])
+    return 10 * len(x) + np.sum(x**2 - 10 * np.cos(2 * pi * x))
 
 
-def inverse_rastrigin(x: list) -> float:
+def inverted_rastrigin(x: np.array) -> float:
     """
     Inverted Rastrigin function.
 
     The Rastrigin function has several local minima. It is highly multimodal, but locations of the minima
     are regularly distributed. This implementation inverts the function to test out the maximization
 
-    :param list x: list of floats. Values usually are between -5.12 and 5.12.
+    :param x: array of floats. Values usually are between -5.12 and 5.12.
+    :type x: :class:`npumpy.array`
     :return: the value of the function
     :rtype: float
     """

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/rosenbrock.py

@@ -1,4 +1,7 @@
-def rosenbrock(x: list) -> float:
+import numpy as np
+
+
+def rosenbrock(x: np.array) -> float:
     """
     Rosenbrock function.
 
@@ -8,16 +11,18 @@ def rosenbrock(x: list) -> float:
     The function is unimodal, and the global minimum lies in a narrow, parabolic valley.
     However, even though this valley is easy to find, convergence to the minimum is difficult (Picheny et al., 2012).
 
-    :param list x: list of floats. Values ussually are between -5 and 10
+    The global minima is at [1, 1, ..., 1] with a value of 0
+
+    :param x: array of floats. Values usually are between -5 and 10
+    :type x: :class:`numpy.array`
     :return: the value of the function
     :rtype: float
     """
-    return sum(
-        [100 * (x[i + 1] - x[i] ** 2) ** 2 + (1 - x[i]) ** 2 for i in range(len(x) - 1)]
-    )
+
+    return np.sum(100.0 * (x[1:] - x[:-1] ** 2.0) ** 2.0 + (1 - x[:-1]) ** 2.0, axis=0)
 
 
-def inverted_rosenbrock(x: list) -> float:
+def inverted_rosenbrock(x: np.array) -> float:
     """
     Inverted Rosenbrock function.
 
@@ -27,7 +32,8 @@ def inverted_rosenbrock(x: list) -> float:
     The function is unimodal, and the global minimum lies in a narrow, parabolic valley.
     However, even though this valley is easy to find, convergence to the minimum is difficult (Picheny et al., 2012).
 
-    :param list x: list of floats. Values ussually are between -5 and 10
+    :param x: array of floats. Values ussually are between -5 and 10
+    :type x: :class:`numpy.array`
     :return: the value of the function
     :rtype: float
     """

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/schaffer.py

@@ -1,7 +1,10 @@
 from math import sin, cos
+from typing import Union
 
+import numpy as np
 
-def schaffer_function_no2(x: list) -> float:
+
+def schaffer_function_no2(x: Union[np.array, list]) -> float:
     """
     Schaffer function N. 2.
 
@@ -9,7 +12,8 @@ def schaffer_function_no2(x: list) -> float:
 
     The global minima is at x [0, 0] with value 0
 
-    :param list x: A list of values. Values are evaluated between [-100, 100]
+    :param x: A list of values. Values are evaluated between [-100, 100]
+    :type x: :class:`numpy.array` or list
     :return: The value of the Schaffer function N. 2.
     :rtype: float
     """
@@ -18,7 +22,7 @@ def schaffer_function_no2(x: list) -> float:
     )
 
 
-def inverted_schaffer_function_no2(x: list) -> float:
+def inverted_schaffer_function_no2(x: Union[np.array, list]) -> float:
     """
     Inverted Schaffer function N. 2.
 
@@ -28,14 +32,15 @@ def inverted_schaffer_function_no2(x: list) -> float:
 
     The global maxima is at x [0, 0] with value 0
 
-    :param list x: A list of values. Values are evaluated between [-100, 100]
+    :param x: A list of values. Values are evaluated between [-100, 100]
+    :type x: :class:`numpy.array` or list
     :return: The value of the Inverted Schaffer function N. 2.
     :rtype: float
     """
     return -schaffer_function_no2(x)
 
 
-def schaffer_function_no4(x: list) -> float:
+def schaffer_function_no4(x: Union[np.array, list]) -> float:
     """
     Schaffer function N. 4.
 
@@ -43,7 +48,8 @@ def schaffer_function_no4(x: list) -> float:
 
     The global minima is at x [0, 1.253115] with value 0.292579
 
-    :param list x: A list of values. Values are evaluated between [-100, 100]
+    :param x: array or list of values. Values are evaluated between [-100, 100]
+    :type x: :class:`numpy.array` or list
     :return: The value of the Schaffer function N. 4.
     :rtype: float
     """
@@ -52,7 +58,7 @@ def schaffer_function_no4(x: list) -> float:
     )
 
 
-def inverted_schaffer_function_no4(x: list) -> float:
+def inverted_schaffer_function_no4(x: Union[np.array, list]) -> float:
     """
     Inverted Schaffer function N. 4.
 
@@ -62,7 +68,8 @@ def inverted_schaffer_function_no4(x: list) -> float:
 
     The global maxima is at x [0, 1.253115] with value -0.292579
 
-    :param list x: A list of values. Values are evaluated between [-100, 100]
+    :param x: array or list of values. Values are evaluated between [-100, 100]
+    :type x: :class:`numpy.array` or list
     :return: The value of the Inverted Schaffer function N. 4.
     :rtype: float
     """

{mango-0.2.1 → mango-0.2.2}/mango/benchmark/optimization/schwefel.py

@@ -9,10 +9,10 @@ def schwefel(x: np.array) -> float:
 
     The global minima is located at [420,9687, ..., 420,9687] with a value of 0
 
-    :param :class:`np.array` x: input vector. The function is usually evaluated between [500, 500]
+    :param x: input vector. The function is usually evaluated between [500, 500]
+    :type x: :class:`numpy.array`
     :return: the value of the function
     :rtype: float
-    :doc-author: baobab soluciones
     """
     return 418.9829 * len(x) - np.sum(x * np.sin(np.sqrt(np.abs(x))))
 
@@ -26,9 +26,9 @@ def inverted_schwefel(x: np.array) -> float:
 
     The global minima is located at [420,9687, ..., 420,9687] with a value of 0
 
-    :param :class:`np.array` x: input vector. The function is usually evaluated between [500, 500]
+    :param x: input vector. The function is usually evaluated between [500, 500]
+    :type x: :class:`numpy.array`
     :return: the value of the function
     :rtype: float
-    :doc-author: baobab soluciones
     """
     return -schwefel(x)

{mango-0.2.1 → mango-0.2.2}/mango/clients/arcgis.py

@@ -55,16 +55,17 @@ class ArcGisClient:
                 f"There was an error on login into ArcGis: {response.json()}. Exception: {e}"
             )
 
-    def get_geolocation(self, address: str) -> tuple:
+    def get_geolocation(self, address: str, country: str="ESP") -> tuple:
         """
         Get the geolocation of an address.
 
         :param str address: the address to get the geolocation
+        :param str country: the country of the address to get the geolocation (default Spain)
         :return: a tuple with the longitude and the latitude for the geolocation
         :rtype: tuple
         :doc-author: baobab soluciones
         """
-        url = f"{ARCGIS_GEOCODE_URL}?f=json&token={self.token}&singleLine={address}&sourceCountry=ESP&forStorage=false"
+        url = f"{ARCGIS_GEOCODE_URL}?f=json&token={self.token}&singleLine={address}&sourceCountry={country}&forStorage=false"
         response = requests.get(url=url)
 
         if response.status_code != 200:
@@ -287,6 +288,9 @@ class ArcGisClient:
         data = response.json()["odCostMatrix"]
         results = []
 
+        kilometers = data["costAttributeNames"].index("Kilometers")
+        time = data["costAttributeNames"].index("TravelTime")
+
         for origin in origins["features"]:
             for destination in destinations["features"]:
                 try:
@@ -296,8 +300,9 @@ class ArcGisClient:
                         {
                             "origin": origin["attributes"]["Name"],
                             "destination": destination["attributes"]["Name"],
-                            "distance": data[origin_id][destination_id][2] * 1000,
-                            "time": data[origin_id][destination_id][0] * 60,
+                            "distance": data[origin_id][destination_id][kilometers]
+                            * 1000,
+                            "time": data[origin_id][destination_id][time] * 60,
                         }
                     )
                 except KeyError:

{mango-0.2.1 → mango-0.2.2}/mango/clients/google_cloud_storage.py

@@ -3,6 +3,7 @@ import os
 
 from google.api_core.exceptions import NotFound
 from google.cloud import storage
+
 from .cloud_storage import CloudStorage
 
 
@@ -215,3 +216,30 @@ class GoogleCloudStorage(CloudStorage):
         except NotFound as e:
             log.error(f"Blob {blob_name} does not exist")
             raise e
+
+    def upload_from_folder(
+        self,
+        local_path: str,
+        blob_name: str,
+    ):
+        """
+        The upload_from_folder function uploads all files from a local folder to the Google Cloud Storage bucket.
+
+        :param str local_path: Specify the local path to the folder
+        :param str blob_name: Specify the name of the blob
+        """
+        # Check if the path is a directory
+        if not os.path.isdir(local_path):
+            raise ValueError("The path is not a directory")
+
+        # Walk through the directory and upload the files
+        for root, dirs, files in os.walk(local_path):
+            for file in files:
+                local_file_path = os.path.join(root, file)
+                relative_path = os.path.relpath(local_file_path, local_path)
+                destination_blob_name = os.path.join(blob_name, relative_path).replace(
+                    os.path.sep, "/"
+                )
+
+                # Upload the file to the bucket
+                self.upload_from_filename(local_file_path, destination_blob_name)

{mango-0.2.1 → mango-0.2.2}/mango/config/base_config.py

@@ -210,3 +210,25 @@ class BaseConfig:
         if section is None:
             return KeyError(f"Parameter {key} not found")
         self.parameters.get(section)[key] = value
+
+    @classmethod
+    def create_config_template(cls, output_path: str):
+        """
+        The create_config_template function creates a configuration file with default values for each parameter.
+        If the parameter has a default value, it will be used, otherwise an empty string will be used.
+
+        :param output_file: specify the output path for the template of the config file
+        :doc-author: baobab soluciones
+        """
+        parser = ConfigParser()
+        # Available params are attributes in the form _ChildClass__params
+        params = cls.__getattribute__(cls, "_{}__params".format(cls.__name__))
+        for section, params in params.items():
+            parser.add_section(section)
+            for p in params:
+                if p.default is None:
+                    parser.set(section, p.name, value="")
+                else:
+                    parser.set(section, p.name, value=str(p.default))
+        with open(output_path, "w") as f:
+            parser.write(f)

{mango-0.2.1 → mango-0.2.2}/mango/dashboards/file_explorer_app.py

@@ -10,7 +10,8 @@ import pandas as pd
 import plotly
 import streamlit as st
 from PIL import Image
-
+from mango.processing import write_json, load_json
+from mango.table import Table
 
 class DisplayablePath(object):
     display_filename_prefix_middle = "├──"
@@ -467,8 +468,7 @@ class FileExplorerApp:
                         writer, sheet_name=sheet, index=False
                     )
         elif path_selected.endswith(".json"):
-            with open(path_selected, "w") as f:
-                json.dump(edited_df, f)
+            write_json(edited_df, path_selected)
 
     @classmethod
     def _read_plot_from_html(cls, path_selected):
@@ -621,8 +621,9 @@ class FileExplorerApp:
                                         tab["df"],
                                         use_container_width=True,
                                         key=f"{key_tab}_{path_selected}_{key}",
+                                        num_rows="dynamic",
                                     )
-                                    dict_edited = edited_df.to_dict()
+                                    dict_edited = Table.from_pandas(edited_df).replace_nan()
                                     data[key_tab] = dict_edited
                                     if self.editable:
                                         st.button(

{mango-0.2.1 → mango-0.2.2}/mango/models/pyomo.py

@@ -38,7 +38,7 @@ def safe_value(x):
     This function will return 0 instead.
 
     :param x: a pyomo variable
-    :return:
+    :return: value of the variable
     """
     try:
         if x is not None:
@@ -261,6 +261,13 @@ def model_data_to_excel(model_data, path, file_name="model_data.xlsx"):
 
 
 def solver_result_to_json(result, path):
+    """
+    Save the result object in a json file.
+
+    :param result: result object from pyomo
+    :param path: path of the file
+    :return: nothing
+    """
     def get_val(v):
         try:
             if isinstance(v.value, UndefinedData):
@@ -280,6 +287,13 @@ def solver_result_to_json(result, path):
 
 
 def solver_result_from_json(path, **kwargs):
+    """
+    Load a result object from pyomo
+
+    :param path: path of the file
+    :param kwargs: kwargs for load_json
+    :return: the result object
+    """
     data = load_json(path, **kwargs)
     result = SolverResults()
     for k, v in result.items():