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

Jump to bottom

Gaussian Random Field parameters: Phase 2 #282

Open
2 of 5 tasks
odunbar opened this issue May 5, 2023 · 2 comments
Open
2 of 5 tasks

Gaussian Random Field parameters: Phase 2 #282

odunbar opened this issue May 5, 2023 · 2 comments
Labels
SDI
Milestone
Function-space re...

Comments

@odunbar
Copy link
Member

odunbar commented May 5, 2023 •
edited
Loading

With #252 merged, we have raised some new issues to accompany the GRF tools.

Tasks
Preview Give feedback
  2. Document Darcy example #317
@odunbar odunbar added the SDI label May 5, 2023
@odunbar
Copy link
Member Author

odunbar commented Jun 26, 2023 •
edited
Loading

Deal with #300 here too

  • Update Base.show for function distributions

@odunbar odunbar mentioned this issue Jun 29, 2023
Merged
1 task
@odunbar
Copy link
Member Author

odunbar commented Jul 5, 2023

  • As everything is stacked internally, we should provide an API to obtain the evaluation point grid, for easy reshaping (if we are plotting for example).

bors bot added a commit that referenced this issue Jul 5, 2023
@bors @odunbar
Merge #304
7b6149c 
304: Function parameter documentation r=odunbar a=odunbar

<!--- THESE LINES ARE COMMENTED -->
## Purpose 
<!--- One sentence to describe the purpose of this PR, refer to any linked issues:
#14 -- this will link to issue 14
Closes #2 -- this will automatically close issue 2 on PR merge
-->
Fixes #300 
Addresses GRF docs part of #282 

NB this is merely documenting what is currently implemented, improvements to the API will come soon.

## Content
<!---  specific tasks that are currently complete 
- Solution implemented
-->
- Adds the `constraint` keyword to fix `base.show()` bug with function distributions
- runs `show(parameter_distribution)` during tests to appease codecov
- Adds a section  and example of creating and plotting `GaussianRandomFieldInterface` object and samples.
Relevant docs section found [here](https://clima.github.io/EnsembleKalmanProcesses.jl/previews/PR304/parameter_distributions/#FunctionParameterDistributionType) and [here](https://clima.github.io/EnsembleKalmanProcesses.jl/previews/PR304/parameter_distributions/#function-example).

<!---
Review checklist

I have:
- followed the codebase contribution guide: https://clima.github.io/ClimateMachine.jl/latest/Contributing/
- followed the style guide: https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/
- followed the documentation policy: https://github.com/CliMA/policies/wiki/Documentation-Policy
- checked that this PR does not duplicate an open PR.

In the Content, I have included 
- relevant unit tests, and integration tests, 
- appropriate docstrings on all functions, structs, and modules, and included relevant documentation.

-->

----
- [x] I have read and checked the items on the review checklist.


Co-authored-by: odunbar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
SDI
Projects
None yet
Milestone
Function-space representation of inpu...
Development

No branches or pull requests
1 participant
@odunbar