Changelog#

Changelog entries for the development version are available at https://rosettasciio.readthedocs.io/en/latest/changes.html

0.1 (2023-06-06)#

New features#

  • Add support for reading the .xml-format from Horiba Jobin Yvon’s LabSpec software. (#25)

  • Add support for reading the .tvf-format from TriVista. (#27)

  • Add support for reading the .wdf-format from Renishaw’s WIRE software. (#55)

  • Added subclassing of .sur files in CL signal type and updated metadata parsing (#98)

  • Add optional kwarg to tiff reader multipage_as_list which when set to True uses pages interface and returns list of signal for every page with full metadata. (#104)

Bug Fixes#

  • Ensure that the .msa plugin handles SIGNALTYPE values according to the official format specification. (#39)

  • Fix error when reading Velox file containing FFT with an odd number of pixels (#49)

  • Fix error when reading JEOL .pts file with un-ordered frame list or when length of frame_start_index is smaller than the sweep count (#68)

  • Fix exporting scalebar with reciprocal units containing space (#90)

  • Fix array indexing bug when loading a sur file format containing spectra series. (#98)

  • For more robust xml to dict conversion, convert_xml_to_dict is replaced by XmlToDict (introduced by PR #111). (#101)

  • Fix bugs with reading non-FEI and Velox mrc files, improve documentation of mrc and mrcz file format. Closes #71, #91, #93, #96, #130. (#131)

Improved Documentation#

  • Consolidate docstrings and documentation for all plugins (see also #47, #59, #64, #72) (#76)

  • Remove persistent search field in left sidebar since this makes finding the sidebar on narrow screens difficult. Set maximal major version of Sphinx to 5. (#84)

Deprecations#

  • Remove deprecated record_by attribute from file readers where remaining (#102)

Enhancements#

  • Recognise both byte and string object for NXdata tag in NeXus reader (#112)

API changes#

  • Move, enhance and share xml to dict/list translation and other tools (new api for devs) from Bruker._api to utils: utils.date_time_tools.msfiletime_to_unix function to convert the uint64 MSFILETIME to datetime.datetime object. utils.tools.sanitize_msxml_float function to sanitize some MSXML generated xml where comma is used as float decimal separator. utils.tools.XmlToDict Xml to dict/list translator class with rich customization options as kwargs, and main method for translation dictionarize (#111)

Maintenance#

  • Initiate GitHub actions for tests and documentation. (#1)

  • Initiate towncrier changelog and create templates for PRs and issues. (#3)

  • Add github CI workflow to check links, build docs and push to the gh-pages branch. Fix links and add EDAX reference file specification (#4)

  • Add azure pipelines CI to run test suite using conda-forge packages. Add pytest and coverage configuration in pyproject.toml (#6)

  • Fix minimum install, add corresponding tests build and tidy up leftover code (#13)

  • Fixes and code consistency improvements based on analysis provided by lgtm.org (#23)

  • Added github action for code scanning using the codeQL engine. (#26)

  • Following the deprecation cycle announced in HyperSpy, the following keywords and attributes have been removed:

  • Unify the format_name scheme of IO plugins using name instead and add name_aliases (list) for backwards compatibility. (#35)

  • Add drone CI to test on arm64/aarch64 platform (#42)

  • Unify naming of folders/submodules to match documented format name (#81)

  • Add black as a development dependency. Add pre-commit configuration file with black code style check, which when installed will require changes to pass a style check before commiting. (#86)

  • Add support for python-box 7 (#100)

  • Migrate to API v3 of imageio.v3 (#106)

  • Add explicit support for python 3.11 and drop support for python 3.6, 3.7 (#109)

  • Remove test data from packaging and download them when necessary (#123)

  • Define packaging in pyproject.toml and keep setup.py to handle compilation of C extension (#125)

  • Add release GitHub workflow to automate release process and add corresponding documentation in releasing_guide.md (#126)

  • Add pre-commit hook to update test data registry and pre-commit.ci to run from pull request (#129)

  • Tidy up rsciio namespace: privatise docstrings, move conftest.py and exceptions to tests and utils folder, respectively (#132)

Initiation (2022-07-23)#

  • RosettaSciIO was split out of the HyperSpy repository on July 23, 2022. The IO-plugins and related functions so far developed in HyperSpy were moved to this new repository.