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.

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

Expand documentation on writing out Spectrum1D objects #908

Closed
nmearl opened this issue Dec 13, 2021 · 2 comments
Closed

Expand documentation on writing out Spectrum1D objects #908

nmearl opened this issue Dec 13, 2021 · 2 comments
Assignees

Comments

@nmearl
Copy link
Contributor

nmearl commented Dec 13, 2021

The documentation is currently quite reader-heavy in terms of interacting with spectrum data files. This is a proposal to expand the docs to include more information and examples of writing spectrum files out. The intention is that users would get a useful introduction to the writing functionality in tandem with the reading functionality (i.e. add some information around here), expanding as necessary.

Knowing that the results of spectrum manipulation may be saved out and passed around to colleagues, having test and docs that cover typical formats (fits, asdf, etc.) and ensuring they round-trip properly is needed.

@kelle
Copy link
Member

kelle commented Dec 15, 2021

From #529 , more info also needs to provided for handling uncertainties: "Three uncertainty types are supported: variance (VarianceUncertainty), standard deviation (StdDevUncertainty) and inverse variance (InverseVariance)."

@pllim
Copy link
Member

pllim commented Feb 13, 2023

Duplicate of #905

@pllim pllim marked this as a duplicate of #905 Feb 13, 2023
@pllim pllim closed this as completed Feb 13, 2023
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

No branches or pull requests

3 participants