iwutil 0.1.0__tar.gz

iwutil-0.1.0/.gitignore

@@ -0,0 +1,2 @@
+build
+dist

iwutil-0.1.0/LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2024, Ionworks Technologies Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+- Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

iwutil-0.1.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.3
+Name: iwutil
+Version: 0.1.0
+Summary: Public utility functions for Ionworks code.
+Project-URL: Homepage, https://github.com/ionworks/iwutil
+Project-URL: Issues, https://github.com/ionworks/iwutil/issues
+Author-email: Ionworks Technologies Inc <info@ionworks.com>
+License: Copyright (c) 2024, Ionworks Technologies Inc.
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        - Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        - Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+        
+        - Neither the name of the copyright holder nor the names of its
+          contributors may be used to endorse or promote products derived from
+          this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE.md
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas
+Description-Content-Type: text/markdown
+
+# Ionworks utility functions
+
+Public utility functions for Ionworks code

iwutil-0.1.0/README.md

@@ -0,0 +1,3 @@
+# Ionworks utility functions
+
+Public utility functions for Ionworks code

iwutil-0.1.0/iwutil/__init__.py

@@ -0,0 +1,133 @@
+import os
+import json
+import matplotlib.pyplot as plt
+import numpy as np
+
+
+def subplots_autolayout(
+    n, *args, n_rows=None, figsize=None, layout="constrained", **kwargs
+):
+    """
+    Create a subplot element with a
+    """
+    n_rows = n_rows or int(n // np.sqrt(n))
+    n_cols = int(np.ceil(n / n_rows))
+
+    figwidth_default = min(15, 4 * n_cols)
+    figheight_default = min(8, 1 + 3 * n_rows)
+    figsize = figsize or (figwidth_default, figheight_default)
+    fig, axes = plt.subplots(
+        n_rows, n_cols, *args, figsize=figsize, layout=layout, **kwargs
+    )
+    # if we just have a single axis, make sure we are returning an array instead
+    if not isinstance(axes, np.ndarray):
+        axes = np.array([axes])
+    axes = axes.flatten()
+
+    return fig, axes
+
+
+def process_folder_file(folder, file):
+    """
+    Process folder and file to create a full path. If folder does not exist, create it.
+
+    Parameters
+    ----------
+    folder : str
+        Folder to save file in
+    file : str
+        File name
+
+    Returns
+    -------
+    str
+        Full path to file
+    """
+    if not os.path.exists(folder):
+        os.makedirs(folder)
+    return os.path.join(folder, file)
+
+
+def save_json(params, folder, file):
+    """
+    Save params to a json file in folder/file
+
+    Parameters
+    ----------
+    params : dict
+        Dictionary of parameters
+    folder : str
+        Folder to save file in
+    file : str
+        File name
+    """
+    full_name = process_folder_file(folder, file)
+    with open(full_name, "w") as f:
+        json.dump(params, f, indent=2)
+
+
+def save_csv(df, folder, file):
+    """
+    Save df to a csv file in folder/file
+
+    Parameters
+    ----------
+    df : pandas.DataFrame
+        DataFrame to save
+    folder : str
+        Folder to save file in
+    file : str
+        File name
+    """
+    full_name = process_folder_file(folder, file)
+    df.to_csv(full_name, index=False)
+
+
+def save_fig(fig, folder, file):
+    """
+    Save fig to a file in folder
+
+    Parameters
+    ----------
+    fig : matplotlib.figure.Figure
+        Figure to save
+    folder : str
+        Folder to save file in
+    file : str
+        File name
+    """
+    full_name = process_folder_file(folder, file)
+    fig.savefig(full_name)
+
+
+def check_and_combine_options(self, default_options, custom_options=None):
+    """
+    Check that all required options are provided, and combine default and custom options
+
+    Parameters
+    ----------
+    default_options : dict
+        Dictionary of default options
+    custom_options : dict, optional
+        Dictionary of custom options, by default None
+
+    Returns
+    -------
+    dict
+        Combined options
+    """
+
+    if custom_options is None:
+        custom_options = {}
+
+    # Check that all custom option keys have a default
+    for k in custom_options:
+        if k not in default_options:
+            raise ValueError(f"Option '{k}' not recognized")
+
+    # If any default options are marked as "[required]", check that they are provided
+    for k, v in default_options.items():
+        if v == "[required]" and k not in custom_options:
+            raise ValueError(f"Option '{k}' is required")
+
+    return {**default_options, **custom_options}

iwutil-0.1.0/iwutil.egg-info/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.1
+Name: iwutil
+Version: 0.1.0
+Summary: Public utility functions for Ionworks code.
+License: Copyright (c) 2024, Ionworks Technologies Inc.
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        - Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        - Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+        
+        - Neither the name of the copyright holder nor the names of its
+          contributors may be used to endorse or promote products derived from
+          this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: numpy
+
+# Ionworks utility functions
+
+Public utility functions for Ionworks code

iwutil-0.1.0/iwutil.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE.md
+README.md
+iwutil.py
+pyproject.toml
+iwutil.egg-info/PKG-INFO
+iwutil.egg-info/SOURCES.txt
+iwutil.egg-info/dependency_links.txt
+iwutil.egg-info/requires.txt
+iwutil.egg-info/top_level.txt

iwutil-0.1.0/iwutil.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

iwutil-0.1.0/iwutil.egg-info/requires.txt

@@ -0,0 +1,3 @@
+matplotlib
+pandas
+numpy

iwutil-0.1.0/iwutil.egg-info/top_level.txt

@@ -0,0 +1 @@
+iwutil

iwutil-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "iwutil"
+description = "Public utility functions for Ionworks code."
+authors = [{ name = "Ionworks Technologies Inc", email = "info@ionworks.com" }]
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { file = "LICENSE.md" }
+version = "0.1.0"
+dependencies = [
+    "matplotlib",
+    "pandas",
+    "numpy"
+]
+
+[project.urls]
+Homepage = "https://github.com/ionworks/iwutil"
+Issues = "https://github.com/ionworks/iwutil/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"