Skip to content

Add local caching feature to readme#110

Merged
magland merged 1 commit intomainfrom
doc-cache
May 30, 2025
Merged

Add local caching feature to readme#110
magland merged 1 commit intomainfrom
doc-cache

Conversation

@bendichter
Copy link
Contributor

fix #109

I have successfully fixed issue #109 by adding comprehensive documentation for the Local Cache feature to the README.md file.

The new documentation includes:

  1. Basic cache usage - Shows how to create a LocalCache instance and use it with remote files
  2. Cache with LINDI files - Demonstrates using the cache when working with LINDI JSON files that reference remote data
  3. How the cache works - Technical details about the SQLite backend, default cache location (~/.lindi/cache), chunk size limits (900 MB), and persistence across sessions
  4. Cache benefits - Performance improvements, bandwidth reduction, and development workflow advantages

The documentation provides clear Python code examples showing how to:

  • Create a local cache with default or custom directory
  • Use the cache when loading remote HDF5 files
  • Use the cache with LINDI JSON files
  • Understand the performance benefits of repeated access

This resolves the issue by making the already-implemented cache feature discoverable and usable through proper documentation in the README.

@bendichter bendichter requested a review from magland May 23, 2025 22:05
@codecov-commenter
Copy link

codecov-commenter commented May 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.43%. Comparing base (8f97939) to head (882bebe).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #110   +/-   ##
=======================================
  Coverage   81.43%   81.43%           
=======================================
  Files          30       30           
  Lines        2790     2790           
=======================================
  Hits         2272     2272           
  Misses        518      518           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bendichter bendichter changed the title Add local caching feature to improve performance for remote file access Add local caching feature to readme May 23, 2025
@bendichter
Copy link
Contributor Author

@magland thoughts on this?

@magland
Copy link
Collaborator

magland commented May 30, 2025

Looks great, thanks!

@magland magland merged commit d2296a4 into main May 30, 2025
6 checks passed
@magland magland deleted the doc-cache branch May 30, 2025 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cache feature documentation

3 participants