! Changes for v1.0.10a

CHANGELOG.md

@@ -5,13 +5,23 @@ 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.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.10a] - 2023-11-14
 
-## [1.0.10] - 2023-10-18
+### Fixed
+
+- Removed `numba` from dependencies altogether, should help fix
+- Added version cap to `ruamel`. This should prevent getting errors related to the yaml parser and avoid getting stuck in dependency hell during install
+- Removed unnecessary print statement in load functions.
 
 ### Changed
 
-- Made `numpy` an optional dependency, this should improve package compatibility across OS
+- Fixed reference to `numpy` in previous changelog to `numba`.
+
+## [1.0.10] - 2023-10-18
+
+### Changed
 
+- Made `numba` an optional dependency, this should improve package compatibility across OS
 
 ## [1.0.9] - 2023-10-13
 

README.md

@@ -10,9 +10,37 @@ ORPL (read _orpel_) is the Open Raman Processing Library. It provides tools for
 
 As of v1.0.0, ORPL also provides a Graphical User Interface. See demo below ;)
 
+## News
+
+I was notified of a few compatibility problems with the use of ORPL on non-linux systems. Most of the difficulties were traced back to making numba behave with MacOS and Windows. Starting with version v1.0.10a, I removed `numba` from the required libraries list. As such, it will no longer be installed on its own along `orpl`. However, if it is installed _explicitely_ (by running `pip install numba`), it will provide a significant boost for the performance of baseline removal filters. In the future I plan to find another library to handle JIT compilation to achieve the same benefits.
+
+In addition, I was also notified of an error that a few people encountered when trying load a spectrum file in ORPL GUI. The GUI would launch fine, but would crash when trying to load a spectrum. Part of the error message is as follow,
+
+```python
+"dump()" has been removed, use
+
+yaml = YAML(typ='unsafe', pure=True)
+yaml.dump(...)
+```
+
+This error is caused by a newer version that was pushed for the [ruamel](https://pypi.org/project/ruamel.yaml/) library that I use to parse YAML. I will need to change a few things, but for now an easy fix was to limit this dependency to versions prior to 0.18. If you encountered this error, there are two ways to fix it.
+
+First, you can explicitely install ruamel with a version that does not cause this issue,
+
+```shell
+pip install "ruamel.yaml<0.18.0"
+```
+
+Or you can force an `orpl` update,
+
+```shell
+pip install --upgrade orplib
+```
+
 ## Table of content
 
 - [ORPL](#orpl)
+  - [News](#news)
   - [Table of content](#table-of-content)
   - [ORPL GUI in action](#orpl-gui-in-action)
   - [Installation](#installation)

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = orplib
-version = 1.0.10
+version = 1.0.10a
 author = Guillaume Sheehy
 author_email = [email protected]
 description = Open Raman Processing Library
@@ -23,13 +23,12 @@ python_requires = >=3.8
 include_package_data = True
 install_requires=
     matplotlib>=3.5.1
-    numba>=0.55.1
     numpy>=1.21.5
     scipy>=1.7.3
     pyperclip>=1.8.2
     qtmodern>=0.2.0
     PyQt5>=5.15
-    ruamel.yaml>=0.17
+    ruamel.yaml<0.18.0
     sif-parser>=0.3.0
     renishawWiRE>=0.1.16