Improvements to parameters and preferences

rbeyer / kalasiris

A Python library to wrap functions and functionality for the Integrated Software for Imagers and Spectrometers (ISIS).

https://kalasiris.readthedocs.io

BSD 3-Clause "New" or "Revised" License

9 stars 5 forks source link

Improvements to parameters and preferences #14

Closed rbeyer closed 1 year ago

rbeyer commented 1 year ago

Description

New kalasiris.set_persistent_preferences() functionality so that a library user can set a persistent preferences path rather than having to enter it with each kalasiris function run. Addresses Issue #11.
Can now also pass parameters that do not take an argument to ISIS in a manner similar to how you'd write them on the command line (e.g. getkey("-help")) in addition to the "old" way (e.g. getkey("help__")).

Related Issue

Would close #11 .

How Has This Been Tested?

make docs
make test-all

Types of changes

New feature (non-breaking change which adds functionality)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

Licensing:

This project is released under the LICENSE.

I claim copyrights on my contributions in this pull request, and I provide those contributions via this pull request under the same license terms that the pvl project uses.

codecov[bot] commented 1 year ago

Codecov Report

Merging #14 (cba3cfb) into main (d22e502) will increase coverage by 0.10%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #14      +/-   ##
==========================================
+ Coverage   92.50%   92.60%   +0.10%     
==========================================
  Files          12       12              
  Lines         480      487       +7     
==========================================
+ Hits          444      451       +7     
  Misses         36       36

Impacted Files	Coverage Δ
kalasiris/cubenormfile.py	`88.57% <ø> (-0.32%)`	:arrow_down:
kalasiris/__init__.py	`100.00% <100.00%> (ø)`
kalasiris/kalasiris.py	`92.10% <100.00%> (+2.39%)`	:arrow_up:

... and 3 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.