Skip to content

Reference XDG_CACHE_HOME in the documentation #41

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
alisterburt merged 4 commits into from
May 27, 2025
Merged

Reference XDG_CACHE_HOME in the documentation #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
55bb509
Update README.md w/ cache dir information
ratolon May 27, 2025
48752e2
Update index.md w/ cache dir information
ratolon May 27, 2025
8f287e0
Update index.md, recover accidentaly deleted character
ratolon May 27, 2025
70239c6
Update index.md to fix header level
ratolon May 27, 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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ If trying to use an `10.X` CUDA runtime you may have to install older versions o
`torch` and `pytorch-lightning`, see
[teamtomo/fidder#17](https://github.com/teamtomo/fidder/issues/17) for details.

### Model weights cache directory
Fidder will fetch the needed weights from Zenodo on its first run. To do so, [pooch](https://www.fatiando.org/pooch/latest/index.html) is used to download the weights to your computer. In Unix-like systems, this will [default](https://www.fatiando.org/pooch/latest/api/generated/pooch.os_cache.html#pooch-os-cache) to _~/.cache/fidder_ unless XDG_CACHE_HOME is set to a different location.

## Notes

This package provides similar functionality to
Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ If trying to use an `10.X` CUDA runtime you may have to install older versions o
`torch` and `pytorch-lightning`, see
[teamtomo/fidder#17](https://github.com/teamtomo/fidder/issues/17) for details.

## Model weights cache directory
Fidder will fetch the needed weights from Zenodo on its first run. To do so, [pooch](https://www.fatiando.org/pooch/latest/index.html) is used to download the weights to your computer. In Unix-like systems, this will [default](https://www.fatiando.org/pooch/latest/api/generated/pooch.os_cache.html#pooch-os-cache) to _~/.cache/fidder_ unless XDG_CACHE_HOME is set to a different location.

# Notes

This package provides similar functionality to
Expand Down
Loading