aesoptparam 0.3.6a0__tar.gz

aesoptparam-0.3.6a0/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = **/test/*

aesoptparam-0.3.6a0/.gitignore

@@ -0,0 +1,11 @@
+*.ipynb
+.vscode
+__pycache__
+.pytest_cache
+*.egg-info
+.coverage
+_build
+build
+.env
+.tool-versions
+dist/

aesoptparam-0.3.6a0/.gitlab-ci.yml

@@ -0,0 +1,27 @@
+image: continuumio/anaconda3
+
+before_script:
+  - python -m venv ~/aesoptparam
+  - source ~/aesoptparam/bin/activate
+
+format_test:
+  script:
+    - pip install -e .[test]
+    - isort aesoptparam --check-only
+    - black --check --diff aesoptparam
+
+tests_coverage: 
+  script:
+    - pip install -e .[test]
+    - pytest -s --cov-report term-missing --cov=aesoptparam ./aesoptparam
+  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
+
+
+pages:
+  script:
+    - pip install .[docs]
+    - sphinx-build -M html docs _build
+    - mv ./_build/html public
+  artifacts:
+    paths:
+    - public

aesoptparam-0.3.6a0/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.5] - 2024-12-17
+
+### Fix
+
+- Refactor for the use of `param.parameters._dict_update` to simply use `dict`
+
+### Changed
+
+- Changed project to be dynamically versioned from git tags
+
+## [0.3.4] - 2024-11-03
+
+### Fix
+
+- `AESOptArray`, `shape` was not fetching shape from string
+- `AESOptArray`, `default` was returned when using `.as_dict(onlychanged=False)`
+- `AESOptArray`, Add possibility to set array with a scalar if `shape` is set
+- `default_ref`, fix for setting `Reference` directly 
+
+## [0.3.3] - 2024-10-11
+
+### Added
+
+- `max_arr_size`, for `display_json_data` to avoid printing large amounts of data for large dict's
+- `.display` method for `AESOptParametrized` to add more control over the rendering 
+
+### Changed
+
+- HTML rendering of `AESOptParametrized` to render values of entries by default. Rendering `list`, `dict` and `ndarray` using `json2html`.
+
+## [0.3.2] - 2024-10-09
+
+### Fix
+
+- `AESOptString`, was missing `___slots__=["default_ref"]` (lead to missing rendering for refs in HTML)
+
+## [0.3.1] - 2024-10-07
+
+### Changed
+
+- `display_json_data`, smoother rendering and extended argument specs
+
+## [0.3.0] - 2024-10-07
+
+### Added 
+
+- `AESOptInteger`, Integer parameter which allow to set references and functions
+- `AESOptBoolean`, Boolean parameter which allow to set references and functions
+- `.has_parent`, to `AESOptParametrized`. Can be used to test if object is *root*
+- `utils.json_utils`, tools for reading and writing json with numpy data
+- `utils.html_repr.json_data_render`, tool for rendering json-data in notebook
+- `utils.copy_param` and `utils.copy_param_ref`, tools for copying parameters while allowing to update/remove some elements. Useful for linking two parameters.
+
+### Fix
+
+- Bug-fix for `AESOptNumber` with `allow_none` to `allow_None`
+
+### Changed
+
+- Allowed `ListOfParametrized` to initialize from function by adding `default_call`
+
+## [0.2.0] - 2024-09-27
+
+### Added 
+
+- `AESOptString`, extension of `param.Sting` which adds *default_ref*
+
+## [0.0.1] - 2024-08-06
+
+### Fixed 
+
+- Included `unit_library.ini` in the wheel build (added to `pyproject.toml`)
+
+## [0.0.0] - 2024-05-06
+First version
+
+### Added
+
+- `AESOptParametrized`, an extension of the `param.Parametrized`
+- `SubParameterized`, dedicated parameter for adding nested parametrized models
+- `ListOfParameterized`, dedicated parameters for adding a list of parametrized models
+- `AESOptNumber`, extension of `param.Number` which adds *units* and *default_ref*
+- `AESOptArray`, extension of `param.Array` which adds *bounds*, *units*, *dtype*, *shape*, *default_full*, *default_interp*,  *default_ref*units

aesoptparam-0.3.6a0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AESOpt Param
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aesoptparam-0.3.6a0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: aesoptparam
+Version: 0.3.6a0
+Author-email: Kenneth Loenbaek <kenloen@dtu.dk>
+Maintainer-email: Kenneth Loenbaek <kenloen@dtu.dk>
+License-File: LICENSE
+Requires-Dist: param
+Requires-Dist: numpy
+Requires-Dist: scipy
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: isort; extra == "test"
+Requires-Dist: black; extra == "test"
+Requires-Dist: jsonschema; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: sphinx_book_theme; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx_external_toc; extra == "docs"
+Requires-Dist: sphinxcontrib.bibtex; extra == "docs"
+Requires-Dist: myst-nb; extra == "docs"
+Requires-Dist: markdown; extra == "docs"
+Requires-Dist: jupytext; extra == "docs"
+Requires-Dist: setuptools; extra == "docs"
+Provides-Extra: all
+Requires-Dist: aesoptparam[docs,test]; extra == "all"
+Dynamic: license-file

aesoptparam-0.3.6a0/README.md

@@ -0,0 +1,52 @@
+# AESOpt Param (`aesoptparam`)
+
+[![pipeline status](https://gitlab.windenergy.dtu.dk/AESOpt/aesoptparam/badges/main/pipeline.svg)](https://gitlab.windenergy.dtu.dk/AESOpt/aesoptparam/-/commits/main) [![coverage report](https://gitlab.windenergy.dtu.dk/AESOpt/aesoptparam/badges/main/coverage.svg)](https://gitlab.windenergy.dtu.dk/AESOpt/aesoptparam/-/commits/main) 
+
+Is a light weight extension of the open source [`param`](https://param.holoviz.org/) project.
+
+The `param` project is a library for handling all the user-modifiable parameters, arguments, and attributes that control code. It adds a way to declare parameters via their type while also adding meta data such as documentation, valid range, etc. For a more extensive introduction user are referred to the project homepage: https://param.holoviz.org/ 
+The [`param`](https://param.holoviz.org/) webpage is also where users are expected to look for more detailed use of `aesoptparam`.
+
+`aesoptparam` is purely extending `param`, by adding the following features:
+
+- Make an extended  `Parameterized` -> `AESOptParameterized`, which adds the following features:
+    - Method for getting data as a dict (`.as_dict`) 
+    - Method for serializing data (`.as_serial`). Used for saving data to JSON, YAML, TOML
+    - Method for setting data from a dict (`.from_dict`). Also works for nested dicts
+    - Method for validating numpy array shapes (`.validate_array_shapes`). See `AESOptArray` for more.
+    - Method for interpolating arrays (`.interp`)
+    - Method for setting values in others units than their default units (`.set_val`)
+    - Method for gettting values in others units than their default units (`.get_val`)
+    - HTML rendering of the `AESOptParameterized` instance  content (Name, Documentation, Type, Range, Units, Value)
+    - Adds posibility for setting a parent_object for nested `AESOptParameterized`, which allows others values to refer to any other value however deeply nested it is
+- A set of new/modified parameters:
+    - `SubParameterized`: Parameter to add nested `AESOptParameterized`. It will automatically add the parent object.
+    - `ListOfParameterized`: Parameter to add a list of `AESOptParameterized`. 
+    - `AESOptString`: Adds the following list of attributes or methods:
+        - `default_ref`: Referencing another parameter string
+    - `AESOptBoolean`: Adds the following list of attributes or methods:
+        - `default_ref`: Referencing another parameter string
+    - `AESOptNumber`: Adds the following list of attributes or methods:
+        - `units`
+        - `default_ref`: Referencing another parameter number
+    - `AESOptInteger`: Adds the following list of attributes or methods:
+        - `units`
+        - `default_ref`: Referencing another parameter number
+    - `AESOptArray`: Adds the following list of attributes or methods:
+        - `bounds`, `softbounds`. `inclusive_bounds`, similar to [`param.Number`](https://param.holoviz.org/user_guide/Parameter_Types.html#numbers)
+        - `units`
+        - `dtype`: The array data type
+        - `shape`: The shape of the array. Can also be a reference to another parameter. Used for validating array shape.
+        - `default_full`: Makes the default a array full of a given number. Using `numpy.full`. The first argument can reference others parameters to get their shape.
+        - `default_interp`: The default is to interpolate the array from other arrays. Arguments can both be arrays or references to others arrays.
+        - `default_ref`: Referencing another parameter array
+
+Besides the core features above, it also adds some utility tools:
+
+- `display_json_data` : Function to render JSON compliant data as a HTML table in Jupyter notebooks. It also works for numpy data that has numeric data dtypes.
+- `read_json` : Method for reading JSON data file, which automatically can convert numeric list's to numpy. 
+- `write_json` : Method for writing JSON data file, which automatically can convert numeric numpy arrays and types to list of build-in types.
+
+## Documentation
+
+[AESOpt Param Documentation](https://aesopt.pages.windenergy.dtu.dk/aesoptparam)

aesoptparam-0.3.6a0/aesoptparam/__init__.py

@@ -0,0 +1,13 @@
+from param import *
+
+from .parameterized import AESOptParameterized
+from .parameters import (
+    AESOptArray,
+    AESOptBoolean,
+    AESOptInteger,
+    AESOptNumber,
+    AESOptString,
+    ListOfParameterized,
+    SubParameterized,
+)
+from .utils import copy_param, copy_param_ref

aesoptparam-0.3.6a0/aesoptparam/example.py

@@ -0,0 +1,110 @@
+import numpy as np
+
+from aesoptparam import (
+    AESOptArray,
+    AESOptNumber,
+    AESOptParameterized,
+    AESOptString,
+    Dict,
+    ListOfParameterized,
+    String,
+    SubParameterized,
+    copy_param,
+    copy_param_ref,
+)
+
+
+class sub1_class(AESOptParameterized):
+    """Docs sub1"""
+
+    a = AESOptNumber(5.0, doc="Docs for sub1.a", bounds=(0, 10))
+    b = AESOptArray(np.linspace(0, 10, 10), doc="Docs for sub1.b")
+    c = AESOptArray(default_ref=".b", doc="Docs for sub1.c")
+    e = AESOptArray(
+        lambda self: np.full_like(self.b, self.a), shape=".b", doc="Docs for sub1.e"
+    )
+    f = AESOptArray(default_full=(".b", ".a"), doc="Docs for sub1.d")
+    g = AESOptArray(default_full=(".b", 6.0), doc="Docs for sub1.g")
+    h = AESOptArray(
+        default_interp=(np.linspace(0, 10, 5), ".b", ".c"), doc="Docs for sub1.h"
+    )
+    i = AESOptString("sub1.Dummy", doc="Docs for sub1.i")
+    j = AESOptString(".i", doc="Docs for sub1.j")
+    k = AESOptString(lambda self: self.i + "2", doc="Docs for sub1.k")
+
+
+class sub2_class(AESOptParameterized):
+    """Docs sub2"""
+
+    a = copy_param_ref(
+        sub1_class.param.a, "..sub1.a", update=dict(doc="Docs for sub2.a")
+    )
+    b = AESOptNumber(default_ref="..a", doc="Docs for sub2.b")
+    c = AESOptNumber(default_ref="..sub_list[0].a", doc="Docs for sub2.c")
+    d = copy_param_ref(
+        sub1_class.param.b, "..sub1.b", update=dict(doc="Docs for sub2.d")
+    )
+    e = AESOptArray(
+        lambda self: (
+            None if self.parent_object.sub1.b is None else self.parent_object.sub1.b + 1
+        ),
+        doc="Docs for sub2.e",
+    )
+    f = AESOptString("..f", doc="Docs for sub2.f")
+    g = copy_param_ref(
+        sub1_class.param.i, "..sub1.i", update=dict(doc="Docs for sub2.g")
+    )
+    h = AESOptString("..sub_list[0].f", doc="Docs for sub2.h")
+
+
+class sub_list_class(AESOptParameterized):
+    """Docs sub_list"""
+
+    a = AESOptNumber(6.0, doc="Docs for sub_list.a")
+    b = AESOptNumber(default_ref="..a", doc="Docs for sub_list.b")
+    c = AESOptNumber(default_ref="..sub1.a", doc="Docs for sub_list.c")
+    d = AESOptArray(default_ref="..d", doc="Docs for sub_list.d")
+    e = AESOptArray(default_ref="..sub1.b", doc="Docs for sub_list.e")
+    f = AESOptString(default_ref="..f", doc="Docs for sub_list.f")
+    g = AESOptString(default_ref="..sub1.i", doc="Docs for sub_list.g")
+
+
+class main(AESOptParameterized):
+    """Main object"""
+
+    version = String("0.0.0", readonly=True, precedence=0.0)
+    name = String("Dummy", doc="Main dummy", precedence=0.01)
+    a = AESOptNumber(4.0, units="rad/s", doc="Docs for .a", bounds=(0, 10))
+    b = AESOptNumber(default_ref=".sub1.a", units="m/s", doc="Docs for .b")
+    c = AESOptNumber(default_ref=".sub_list[0].a", doc="Docs for .c")
+    d = AESOptArray(
+        default_ref=".sub1.b", units="mm/s", doc="Docs for .d", bounds=(0, 10)
+    )
+    e = AESOptArray(
+        np.array([0, 1, 2, 3]),
+        shape=4,
+        units="mm/s",
+        doc="Docs for .d",
+        bounds=(0, 10),
+        dtype=int,
+    )
+    f = AESOptString("Dummy", doc="Docs for .f")
+    g = AESOptString(".f", doc="Docs for .g")
+    h = AESOptString(lambda self: self.f + "2", doc="Docs for .h")
+    i = Dict(doc="Docs for .i")
+    sub1 = SubParameterized(sub1_class)
+    sub2 = SubParameterized(sub2_class)
+    sub_list = ListOfParameterized(sub_list_class)
+    sub_list2 = ListOfParameterized(
+        sub_list_class, default_call=lambda self: [self.add_sub_list2()]
+    )
+
+    def add_sub_list(self, **params):
+        return self.add_ListOfParameterized_item(
+            "sub_list", self.param.sub_list.item_type, **params
+        )
+
+    def add_sub_list2(self, **params):
+        return self.add_ListOfParameterized_item(
+            "sub_list2", self.param.sub_list2.item_type, **params
+        )