fameio 1.8.2__tar.gz → 2.0.0__tar.gz

fameio-2.0.0/CHANGELOG.md

@@ -0,0 +1,204 @@
+<!-- SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
+
+SPDX-License-Identifier: CC0-1.0 -->
+
+# Changelog
+
+## [2.0.0 - 2024-04-03](https://gitlab.com/fame-framework/fame-io/-/tags/v2.0.0)
+### Changed
+- **Breaking**: Removed support for `python==3.8` #163 (@dlr-cjs @dlr_fn)
+- **Breaking**: Signature of `run` functions in `make_config.py` and `convert_results.py` changed: the input file is now read from the configuration dictionary #163 (@dlr-cjs @dlr_fn)
+- **Breaking**: Created protobuf files now have a header section -> minimum required FAME-Core version is now 1.6.0 #183 (@dlr-cjs @dlr_fn)
+- Raise error for NaN float values in scenario and time series #165 (@dlr-cjs @dlr_fn)
+- Enhance Schema to include metadata and output fields #156 (@dlr-cjs @litotes18 @dlr_fn)
+- Enhance Contracts to include metadata #158 (@dlr-cjs @litotes18 @dlr_fn)
+- Enhance Agents to include metadata #159 (@dlr-cjs @litotes18 @dlr_fn)
+- Improve general handling of CLI arguments #163 (@dlr_fn @dlr-cjs)
+- Ensure `fameio` logger is used consistently !126 (@dlr-cjs @dlr_fn)
+- Enhanced error message if mandatory attribute is not defined by logging `full_name` #177 (@dlr_fn)
+- Switch to pyproject.toml #173 (@dlr-cjs)
+- Restrict supported pandas versions #171 (@dlr-cjs)
+- Enable to specify defaults for MERGE_TIME parameters #179 (@dlr-cjs)
+- Conserve order of keys in YAML files #186 (@dlr-cjs @dlr_fn)
+- Update to `fameprotobuf==1.4.0` #189 (@dlr-cjs @dlr_fn)
+- Update `CHANGELOG.md` to conform with Common Changelog format #172 (@dlr-cjs @dlr_fn)
+
+### Added
+- Write Schema and Metadata of Contracts and Agents to protobuf file #160 (@dlr-cjs @litotes18 @dlr_fn)
+- Add option to recover input data `--input-recovery`/`--no-input-recovery` #163 (@litotes18 @dlr_fn @dlr-cjs)
+- Add pipeline tests for all major Python versions >= 3.8 #173 (@dlr-cjs)
+- Read all input from protobuf file #162 (@dlr-cjs @litotes18 @dlr_fn)
+- Write all input from protobuf to disk #163 (@litotes18 @dlr_fn @dlr-cjs)
+- Add header section to input protobuf enabling recovering of inputs from protobuf #183 (@dlr-cjs @dlr_fn)
+- Add pipeline tests for all major Python versions >= 3.8, < 3.12 #173 (@dlr-cjs)
+- Enable comments in timeseries using '#' #184 (@dlr-cjs)
+- Raise Warning if Agent has no Contracts attributed #187 (@dlr_fn)
+- Add JOSS Paper in folder paper/ #139 (@dlr-cjs @litotes18 @dlr_fn)
+- Add `CONTRIBUTING.md` #102 (@dlr-cjs @dlr_fn)
+- Add `Citation.cff` #166 (@dlr-cjs)
+
+### Removed
+- Remove deprecated protobuf test !127 (@dlr-cjs @dlr_fn)
+
+### Fixed
+- Fix deprecated arguments in pandas groupby !129 (@maurerle)
+- Fix breaking tests in Pytest 8.0 #176 (@dlr-cjs)
+- Fix PyTests for Python 3.12 #182 (@dlr_fn)
+
+## [1.8.1 - 2023-05-04](https://gitlab.com/fame-framework/fame-io/-/tags/v1.8.1)
+### Fixed
+- Fix fail of `ConvertFameResults` when `merge-times` was not specified
+
+## [1.8.0 - 2023-04-14](https://gitlab.com/fame-framework/fame-io/-/tags/v1.8)
+### Changed
+- Update repository to be compliant to `REUSE` standard
+- Accept custom `date_format` (default: `"%Y-%m-%d_%H:%M:%S"`) for `FameTime.convert_fame_time_step_to_datetime()`
+- Parse command-line arguments case-insensitive for arguments with predefined options
+- Handle potentially missing cli arguments in `cli.update_default_config` for `makeFameRunConfig` and `convertFameResults` in a robust way.
+
+### Added
+- **Breaking**: Add option to define conversion of time steps to given format (default=`UTC`) by `-t/--time {UTC, INT, FAME}` for `convertFameResults`
+- Add option to merge time steps in results with `convertFameResults`
+- Add pre-commit hooks enforcing high coding standards and reducing CI runner minutes during development
+
+## [1.7.0 - 2023-02-20](https://gitlab.com/fame-framework/fame-io/-/tags/v1.7)
+### Added
+- Support dictionaries in Schema for field `Products` in elements of `AgentTypes`
+- Support dictionaries in Schema for field `Values` in elements of `Attributes`
+
+### Changed
+- Use `Pathlib` for path handling
+- Improve error message when no valid `YAML` file is specified for `makeFameRunConfig`
+
+### Remove
+- **Breaking**: `Products` in Schema no longer support single non-list values
+
+## [1.6.3 - 2022-11-04](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6.3)
+### Added
+- Allow parsing `Help` for `Attributes` in `schema`
+
+## [1.6.1 - 2022-11-02](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6.1)
+### Changed
+- Use existing logger if already set up to avoid duplicates when `fameio` is used as dependency in third party workflows
+
+## [1.6.0 - 2022-07-08](https://gitlab.com/fame-framework/fame-io/-/tags/v1.6)
+### Added
+- Add option to enable memory saving mode using the flag `-m` or `--memory-saving`
+- Add options to deal with complex indexed output columns using the flag `-cc` or `--complex-column` with
+  options `IGNORE`, `MERGE` or `SPLIT`
+
+### Changed
+- **Breaking**: Update requirement to `python>=3.8`
+- **Breaking**: Update requirement to `fameprotobuf==v1.2`
+- Enable parsing of protobuf output files > 2 GB
+- Reduce memory profile for `convertFameResults`
+- Extract `source` scripts relevant for `convertFameResults` to be hosted in subpackage `results`
+
+## [1.5.4 - 2022-06-01](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.4)
+### Changed
+- Limit `protobuf` dependency to `>=3.19,<4.0`
+
+## [1.5.3 - 2022-03-18](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.3)
+### Changed
+- Harmonize interface with `famegui`
+- Return `None` on failure of `resolve_series_file_path` instead of raising a `FileNotFoundError`
+
+## [1.5.2 - 2022-03-10](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.2)
+### Changed
+- Allow interfacing of `famegui` with `scenario` (e.g. serialization, error handling)
+- Move `scenario` validation to `validator.py`
+- Extract `path_resolver.py`
+- Increase test coverage by incorporating [AMIRIS examples](https://gitlab.com/dlr-ve/esy/amiris/examples)
+
+## [1.5.1 - 2022-01-10](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5.1)
+### Added
+- Provide documentation on installation using `pipx`
+- Add optional argument `-se`/`--singleexport` for exporting individual files for each agent
+- Add compatibility hook for `famegui` integration
+
+### Changed
+- Refactor `scenario.py`
+- Ensure code formatting using `black`
+
+## [1.5.0 - 2021-06-30](https://gitlab.com/fame-framework/fame-io/-/tags/v1.5)
+### Added
+- Support specifying an output folder in command line interface of `convert_results.py`
+
+### Changed
+- Update to latest protobuf package
+- Refactor code
+
+## [1.4.0 - 2021-06-10](https://gitlab.com/fame-framework/fame-io/-/tags/v1.4)
+### Added
+- Enable "Default" values for Attributes - these are used in case a mandatory attribute is not specified in the Scenario
+- Allow "List" Attributes with multiple values
+- Add new AttributeTypes "Long", "String" and "TimeStamp"
+- Add compact definition of multiple contracts: enable lists for senders and receivers
+
+### Changed
+- **Breaking**: Update requirement to `fameprotobuf==1.1.4`
+- Refactor `make_config.py`: split into several classes and packages, improved exception handling
+- Switch to pytest and improved test coverage
+- Make keywords in Schema and Scenario case-insensitive
+- Improve validations for Schema and Scenario
+
+### Fixed
+- Fixed minor bugs
+
+## [1.3.0 - 2021-04-13](https://gitlab.com/fame-framework/fame-io/-/tags/v1.3)
+### Added
+- Enable `Attributes` in agents (formerly known as `Fields`) to be structured in complex tree-like data dictionaries
+- Allow contracts to support `Attributes` of type `int`, `float`, `enum` or `dict`
+- Add coverage report badge
+- Add `CHANGELOG.md`
+
+### Changed
+- **Breaking**: Use new format `DataStorage` for input and output protobuf files allowing `FAME-Core` input and output to be written to the same file (requires `FAME-Core > 1.0`)
+- **Breaking**: Update requirement to `fameprotobuf==1.1.2`
+- Enable automatic detection of `TimeStamps` by string format and conversion to int64
+- Raise proper error when file can not be loaded triggered by `!include` command
+- Raise critical error when trying to convert empty protobuf output file
+- Check if `product` in `contract` is valid according to `schema.yaml`
+
+## [1.2.4 - 2021-02-26](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.4)
+### Changed
+- Move `is_compatible` function to class `AttributeType`
+
+## [1.2.3 - 2021-02-24](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.3)
+### Fixed
+- Fix file prefix `IGNORE_` (used when loading a set of contract files with the !include argument) is now working consistently
+
+## [1.2.2 - 2021-02-18](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.2)
+### Changed
+- **Breaking**: Rename `fieldtype` to `attributetype` in `schema.yaml`
+- Derive protobuf imports from `fameprotobuf` package
+- Improve handling of cases for keys in `scenario.yaml`
+- Improve handling of time stamp strings
+
+## [1.2.1 - 2021-02-10](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2.1)
+### Changed
+- Improve key handling for contracts which are now case-insensitive
+
+## [1.2.0 - 2021-02-04](https://gitlab.com/fame-framework/fame-io/-/tags/v1.2)
+### Added
+- Add `!include` command to yaml loading to allow integrating additional yaml files
+
+### Changed
+- **Breaking**: Rename package to `fameio`
+- Improve executables
+- Restructure logging
+- Improve documentation
+
+### Fixed
+- Fix bugs
+
+## [1.1.0 - 2020-12-09](https://gitlab.com/fame-framework/fame-io/-/tags/v1.1)
+### Added
+- Package to PyPI
+- Provide executables for calling `makeFameRunConfig` and `convertFameResults`
+
+### Changed
+- Improve documentation
+
+## [1.0.0 - 2020-11-17](https://gitlab.com/fame-framework/fame-io/-/tags/v1.0)
+_Initial release of `famepy`_

fameio-2.0.0/LICENSES/Apache-2.0.txt

@@ -0,0 +1,178 @@
+Copyright 2020 German Aerospace Center
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS