Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: axis conversion #113

Merged
merged 10 commits into from
Mar 20, 2022
Merged

Documentation: axis conversion #113

merged 10 commits into from
Mar 20, 2022

Conversation

jlaehne
Copy link
Contributor

@jlaehne jlaehne commented Mar 4, 2022

Description of the change

  • Add chapter on axis conversion to documentation.
  • Add links to tutorials on front page and in the menu.
  • Make to_raman_shift alias for to_invcm_relative.
  • Use orange for formulas (as color that works well in bright and dark mode).
  • Detect if laser wavelength is in the metadata

Progress of the PR

  • Change implemented (can be split into several points),
  • Add figure for Jacobian,
  • automatically read laser wavelength if in metadata,
  • ready for review.

@jlaehne jlaehne added the status: WIP work in progress label Mar 4, 2022
@jlaehne jlaehne added this to the v0.2.0 milestone Mar 4, 2022
@jlaehne jlaehne self-assigned this Mar 4, 2022
@codecov-commenter
Copy link

codecov-commenter commented Mar 4, 2022

Codecov Report

Merging #113 (39d425a) into main (699be7d) will increase coverage by 0.06%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #113      +/-   ##
==========================================
+ Coverage   95.70%   95.76%   +0.06%     
==========================================
  Files          11       11              
  Lines         582      591       +9     
==========================================
+ Hits          557      566       +9     
  Misses         25       25              
Impacted Files Coverage Δ
lumispy/signals/luminescence_spectrum.py 90.42% <100.00%> (+0.37%) ⬆️
lumispy/utils/axes.py 96.89% <100.00%> (+0.03%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 699be7d...39d425a. Read the comment docs.

@jlaehne jlaehne added status: needs review and removed status: WIP work in progress labels Mar 17, 2022
@jlaehne
Copy link
Contributor Author

jlaehne commented Mar 17, 2022

The new user-guide page can be found here: https://lumispy--113.org.readthedocs.build/en/113/user_guide/signal_axis.html

@jlaehne jlaehne added documentation Improvements or additions to documentation and removed status: needs review labels Mar 20, 2022
@jlaehne jlaehne merged commit 2258151 into LumiSpy:main Mar 20, 2022
@jlaehne jlaehne deleted the doc-energy branch March 20, 2022 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants