Skip to content

Update README.md #10

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.

Sign up for GitHub

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

Merged
lanery merged 3 commits into from
Mar 12, 2025
Merged

Update README.md #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d368498
Update README.md
lanery Mar 12, 2025
d1ef286
Address security updates
lanery Mar 12, 2025
829b560
Update lint.yml
lanery Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
python-version: "3.12"

- name: Cache Poetry install
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: ~/.local
key: poetry-1.8.3-0
Expand Down
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ This package also facilitates the calibration of spectral data output by the Ope
2. A fine calibration based on Raman-scattered light from a standard sample
(e.g. acetonitrile)

Both calibration steps can be run automatically when spectra of neon and acetonitrile are provided (see [Usage](usage)). This automated procedure builds upon the [calibration procedure](https://github.com/Arcadia-Science/2024-open-raman-analysis/blob/calibration/notebooks/0_generate_calibration.ipynb) implemented by [@sunandascript](https://github.com/sunandascript). For more information on the calibration procedure, see this [blog post](https://www.open-raman.org/robust-calibration-method-for-spectrometers/) by the creator of the OpenRAMAN.
Both calibration steps can be run automatically when spectra of neon and acetonitrile are provided (see [Usage](usage)). This automated procedure builds upon the [calibration protocol](https://dx.doi.org/10.17504/protocols.io.yxmvmemj6g3p/v1) created by Sunanda Sharma and Ben Braverman.
The pub associated with this protocol can be [here](https://doi.org/10.57844/arcadia-cd7e-443b).

For more information on the calibration procedure, see this [blog post](https://www.open-raman.org/robust-calibration-method-for-spectrometers/) by the creator of the OpenRAMAN.


## Installation
Expand Down Expand Up @@ -52,6 +55,10 @@ spectrum = RamanSpectrum.from_openraman_csvfiles(

See [examples](docs/examples/) for more example usage.

## Cited by

Essock-Burns T, Kolb I, Lane R, Mets DG, Sharma S. (2025). "Comparison of spontaneous Raman spectrometers." https://arcadia-science.github.io/2025-raman-spectrometer-comparison/


## Roadmap
1. Add a reader for CRS data from Leica LIF files using [`readlif`](https://github.com/Arcadia-Science/readlif).
Expand Down
88 changes: 48 additions & 40 deletions poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ pandas-stubs = "^2.2.3.241009"
natsort = "^8.4.0"
matplotlib = "^3.9.2"
ramanspy = "^0.2.10"
jinja2 = "^3.1.5"
jinja2 = "^3.1.6"
cryptography = "^44.0.2"

[tool.poetry.group.dev.dependencies]
pre-commit = "3.5.0"
Expand Down