LFS Fixes

[atharva-2001]

📝 Description

Type: 🪲 bugfix | 🚀 feature | ☣️ breaking change | 🚦 testing | 📝 documentation | 🎢 infrastructure

• Removes the runner_os since both platforms use the same LFS
• Allows caching only the atom data file for benchmarks and docs
• Adds documentation for the cache keys
• Prevents cache race conditions
• Fails workflow if cache not found deliberately

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

• Testing pipeline
• Other method (describe)
• My changes can't be tested (explain why)

☑️ Checklist

• I requested two reviewers for this pull request
• I updated the documentation according to my changes
• I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

[tardis-bot]

*beep* *bop*
Hi human,
I ran ruff on the latest commit (058593b).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

25	W291  	[*] Trailing whitespace
12	E999  	[ ] SyntaxError: Expected ',', found ':'
12	W293  	[*] Blank line contains whitespace
5	E902  	[ ] No such file or directory (os error 2)
4	F401  	[ ] `tardis.plasma.equilibrium.rates.collision_strengths.UpsilonCMFGENSolver` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
2	RET505	[ ] Unnecessary `else` after `return` statement
2	I001  	[*] Import block is un-sorted or un-formatted
2	W292  	[*] No newline at end of file
2	D202  	[*] No blank lines allowed after function docstring (found 1)
1	ANN204	[ ] Missing return type annotation for special method `__getitem__`
1	RET506	[ ] Unnecessary `else` after `raise` statement
1	D406  	[*] Section name should end with a newline ("Returns")
1	D407  	[*] Missing dashed underline after section ("Returns")

Complete output(might be large):

.github/actions/setup_env/action.yml:4:8: E999 SyntaxError: Expected an expression
.github/actions/setup_env/action.yml:17:1: W293 [*] Blank line contains whitespace
.github/actions/setup_env/action.yml:19:15: W291 [*] Trailing whitespace
.github/actions/setup_env/action.yml:24:1: W293 [*] Blank line contains whitespace
.github/actions/setup_lfs/action.yml:5:8: E999 SyntaxError: Expected an expression
.github/actions/setup_lfs/action.yml:37:1: W293 [*] Blank line contains whitespace
.github/workflows/benchmarks.yml:3:4: E999 SyntaxError: Expected an expression
.github/workflows/benchmarks.yml:20:5: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:91:49: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:121:81: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:122:54: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:209:1: W293 [*] Blank line contains whitespace
.github/workflows/benchmarks.yml:228:22: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:229:170: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:231:84: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:248:1: W293 [*] Blank line contains whitespace
.github/workflows/build-docs.yml:7:4: E999 SyntaxError: Expected an expression
.github/workflows/lfs-cache.yml:1:12: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
.github/workflows/lfs-cache.yml:37:1: W293 [*] Blank line contains whitespace
.github/workflows/lfs-cache.yml:49:1: W293 [*] Blank line contains whitespace
.github/workflows/lfs-cache.yml:57:1: W293 [*] Blank line contains whitespace
.github/workflows/lfs-cache.yml:62:1: W293 [*] Blank line contains whitespace
.github/workflows/lfs-cache.yml:67:1: W293 [*] Blank line contains whitespace
.github/workflows/lfs-cache.yml:71:1: W293 [*] Blank line contains whitespace
.github/workflows/tests.yml:7:4: E999 SyntaxError: Expected an expression
CHANGELOG.md:4:15: E999 SyntaxError: Expected ',', found ':'
CITATION.cff:3:1: E999 SyntaxError: Invalid annotated assignment target
README.rst:1:1: E999 SyntaxError: Expected a statement
docs/contributing/development/continuous_integration.rst:1:1: E999 SyntaxError: Expected a statement
docs/contributing/development/continuous_integration.rst:16:76: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:18:68: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:21:92: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:22:86: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:72:1: W293 [*] Blank line contains whitespace
docs/contributing/development/continuous_integration.rst:106:70: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:121:78: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:122:94: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:123:83: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:124:96: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:126:97: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:127:62: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:134:90: W291 [*] Trailing whitespace
docs/contributing/development/continuous_integration.rst:135:19: W292 [*] No newline at end of file
docs/contributing/development/running_tests.rst:1:1: E999 SyntaxError: Expected a statement
docs/contributing/development/running_tests.rst:59:112: W291 [*] Trailing whitespace
docs/contributing/development/running_tests.rst:60:124: W291 [*] Trailing whitespace
docs/contributing/development/running_tests.rst:64:92: W291 [*] Trailing whitespace
docs/contributing/development/running_tests.rst:65:99: W291 [*] Trailing whitespace
docs/contributing/development/running_tests.rst:75:62: W291 [*] Trailing whitespace
docs/contributing/development/running_tests.rst:76:85: W292 [*] No newline at end of file
docs/physics/plasma/equilibrium/tardis_solver_cmfgen.ipynb:1:1: E902 No such file or directory (os error 2)
docs/resources/credits.rst:1:1: E999 SyntaxError: Expected a statement
tardis/opacities/opacity_state.py:210:9: ANN204 Missing return type annotation for special method `__getitem__`
tardis/opacities/opacity_state.py:216:9: D407 [*] Missing dashed underline after section ("Returns")
tardis/opacities/opacity_state.py:216:9: D406 [*] Section name should end with a newline ("Returns")
tardis/opacities/opacity_state.py:251:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/opacities/tests/test_opacity_state_numba.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/plasma/equilibrium/rates/__init__.py:2:5: F401 `tardis.plasma.equilibrium.rates.collision_strengths.UpsilonCMFGENSolver` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/plasma/equilibrium/rates/__init__.py:3:5: F401 `tardis.plasma.equilibrium.rates.collision_strengths.UpsilonRegemorterSolver` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/plasma/equilibrium/rates/__init__.py:6:5: F401 `tardis.plasma.equilibrium.rates.collisional_rates.ThermalCollisionalRateSolver` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/plasma/equilibrium/rates/__init__.py:9:5: F401 `tardis.plasma.equilibrium.rates.radiative_rates.RadiativeRatesSolver` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/plasma/equilibrium/rates/collisional_ionization_rates.py:1:1: E902 No such file or directory (os error 2)
tardis/plasma/equilibrium/rates/collisional_ionization_strengths.py:1:1: E902 No such file or directory (os error 2)
tardis/plasma/equilibrium/rates/photoionization_rates.py:1:1: E902 No such file or directory (os error 2)
tardis/plasma/equilibrium/rates/photoionization_strengths.py:1:1: E902 No such file or directory (os error 2)
tardis/spectrum/formal_integral.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/spectrum/formal_integral.py:358:13: RET506 Unnecessary `else` after `raise` statement
tardis/spectrum/formal_integral.py:423:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/spectrum/formal_integral.py:716:5: RET505 Unnecessary `else` after `return` statement
tardis/spectrum/formal_integral.py:752:5: RET505 Unnecessary `else` after `return` statement
Found 70 errors.
[*] 45 fixable with the `--fix` option.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.17%. Comparing base (145a995) to head (058593b).
Report is 5 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2954      +/-   ##
==========================================
- Coverage   69.74%   69.17%   -0.57%     
==========================================
  Files         224      228       +4     
  Lines       16313    16429     +116     
==========================================
- Hits        11377    11365      -12     
- Misses       4936     5064     +128     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tardis-bot]

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.