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.

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

Document YAXConfig #157

Merged
merged 3 commits into from
Aug 15, 2022
Merged

Document YAXConfig #157

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3447097
Document YAXConfig
gdkrmr Aug 15, 2022
849b531
Update src/YAXArrays.jl
gdkrmr Aug 15, 2022
4fe6d28
Update src/YAXArrays.jl
gdkrmr Aug 15, 2022
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
13 changes: 13 additions & 0 deletions src/YAXArrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
module YAXArrays

"""
Default configuration for YAXArrays, has the following fields:

- `workdir[]::String = "./"` The default location for temporary cubes.
- `recal[]::Bool = false` set to true if you want `@loadOrGenerate` to always recalculate the results.
- `chunksize[]::Any = :input` Set the default output chunksize.
- `max_cache[]::Float64 = 1e8` The maximum cache used by mapCube.
- `cubedir[]::""` the default location for `Cube()` without an argument.
- `subsetextensions::Array{Any} = []` List of registered functions, that convert subsetting input into dimension boundaries.
"""
global const YAXDefaults = (
workdir = Ref("./"),
recal = Ref(false),
Expand All @@ -7,6 +18,8 @@ global const YAXDefaults = (
cubedir = Ref(""),
subsetextensions = [],
)


global const workdir = YAXDefaults.workdir
global const recal = YAXDefaults.recal
function __init__()
Expand Down