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

Updated file_io.rst to give a MVP for production #132

Merged
merged 5 commits into from
Nov 12, 2024

Conversation

jfkcooper
Copy link
Contributor

@jfkcooper jfkcooper commented Nov 12, 2024

This PR adds alot more details to the fileio_usage.rst to provide better information on how one would use the classes of orsopy to create a bespoke file writer for an instrument.
The code (when ran as a whole) will create a working .ort file with I think all necessary entries.

@jfkcooper jfkcooper requested a review from arm61 November 12, 2024 09:12
docs/fileio_usage.rst Outdated Show resolved Hide resolved
docs/fileio_usage.rst Show resolved Hide resolved
docs/fileio_usage.rst Outdated Show resolved Hide resolved
docs/fileio_usage.rst Outdated Show resolved Hide resolved
docs/fileio_usage.rst Outdated Show resolved Hide resolved
@arm61
Copy link
Contributor

arm61 commented Nov 12, 2024

Some small comments (and one important missing `).

jfkcooper and others added 4 commits November 12, 2024 17:07
Co-authored-by: Andrew McCluskey <andrew@mccluskey.scot>
Co-authored-by: Andrew McCluskey <andrew@mccluskey.scot>
Co-authored-by: Andrew McCluskey <andrew@mccluskey.scot>
@jfkcooper jfkcooper merged commit 40a9297 into reflectivity:main Nov 12, 2024
8 checks passed
@jfkcooper jfkcooper deleted the update_fileio_help branch November 12, 2024 16:24
@jfkcooper
Copy link
Contributor Author

Many thanks @arm61!

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.

2 participants