aesoptparam 0.3.7__py3-none-any.whl

aesoptparam-0.3.7.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: aesoptparam
+Version: 0.3.7
+Author-email: Kenneth Loenbaek <kenloen@dtu.dk>
+Maintainer-email: Kenneth Loenbaek <kenloen@dtu.dk>
+Project-URL: Documentation, https://aesopt.pages.windenergy.dtu.dk/aesoptparam
+Project-URL: DTU-Wind-Gitlab, https://gitlab.windenergy.dtu.dk/AESOpt/aesoptparam
+Project-URL: Changelog, https://gitlab.windenergy.dtu.dk/AESOpt/aesoptparam/-/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: param==2.3.0
+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
+
+# 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.7.dist-info/RECORD

@@ -0,0 +1,21 @@
+aesoptparam/__init__.py,sha256=WS1plVDzZmlXcmnVG5Jqc3oN8on8bbwO4x4Av3U_TFk,280
+aesoptparam/example.py,sha256=hcmxVVq7Q9TjCbLrz-t7o_oVWBjzq-haJGSewIMQHVA,3836
+aesoptparam/parameterized.py,sha256=2ZVdHiuSbgblj-K1zVbrbEyPIhMdns3caTontdJnLhA,16706
+aesoptparam/parameters.py,sha256=ETfYogKI3ewfn5sJr8tHGJn-J5tYc4_1by0_ZFkOavQ,21942
+aesoptparam/serializer.py,sha256=n38JtCymabG8jqS0L3xD0QHlIHDqd4EEKoTOC1dZEYo,3601
+aesoptparam/test/dummy_instance.json,sha256=0tzGKOk4ENq3bF9yMOKGef1ql7xKfkau8MhLvjVyv0o,654
+aesoptparam/test/dummy_schema.json,sha256=cQ02M5Ca95LQpCDa8oltEu1dIjkI1trNxgW54Fgh0Gw,26018
+aesoptparam/test/test_parameterized.py,sha256=yrWbtnG0aoNtRW2m_-Q8mGAuf_jNR1A4hxtSWcPw8Kc,22287
+aesoptparam/test/test_parameters.py,sha256=gqDmlegeUvb6326j7entzLmThLbjP9BO3g3Mu-qWkwM,16849
+aesoptparam/test/test_units.py,sha256=Hu7mLrCVBBPtbjtCWLHKylkRIBPT5ytDgsAfWfVFT1E,9368
+aesoptparam/test/test_utils.py,sha256=sT5_AA6cw4MLD7Uor3Gc2u2ZyPWB95Tq0Crx2L2JrFk,4643
+aesoptparam/utils/__init__.py,sha256=XPi7ACQVWaZi6lEYnLEGDX4B91QFn1wshskaHeJR6Lk,1936
+aesoptparam/utils/html_repr.py,sha256=j9OWd9bVkpSoieDC-NP0hq-Wkh5lr0ogas_9Zuq0_gg,18872
+aesoptparam/utils/json_utils.py,sha256=9ZUazW5-wPiFHnN40uQ5D3sc09WtTA5uY3BVvCQrQO8,3394
+aesoptparam/utils/unit_library.ini,sha256=JPjj-0S91TnIbPbAZF402Ch2ThUlX7s6m9F7HxvBt8I,5877
+aesoptparam/utils/units.py,sha256=83tj5EpbRAiK4NDJZ1yK3Bzi1XSe_VEcNzLjfuur0-Q,29261
+aesoptparam-0.3.7.dist-info/licenses/LICENSE,sha256=ibW0KQU0XMBL4YyHq4VrsUdOfVwiCm0a8mg7vhnnGM0,1069
+aesoptparam-0.3.7.dist-info/METADATA,sha256=fhJB5z1vpRnw035WBYOos_uuX-449z5yAY1uNHaosJc,5463
+aesoptparam-0.3.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+aesoptparam-0.3.7.dist-info/top_level.txt,sha256=3pOxxBNWz5UaENX7nq8QPNS9iNba9MuimiJFVmo5dIw,12
+aesoptparam-0.3.7.dist-info/RECORD,,

aesoptparam-0.3.7.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aesoptparam-0.3.7.dist-info/licenses/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.7.dist-info/top_level.txt

@@ -0,0 +1 @@
+aesoptparam