-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add How-To Guides #15
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I was writing these guides, I have run into some questions about our functionality:
How to register an instrument with ResINS | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
?????????????????? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to have the ability (for people who are creating a new instrument without changing ResINS) to insert the new instrument file into INSTRUMENT_MAP
? That way, they would be to use Instrument.from_default
instead of Instrument.from_file
. All we would need to do for this to be possible is to allow INSTRUMENT_MAP
entries to also be full paths, which could be done by adding a os.path.exists
check to Instrument._get_file
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That seems pretty innocuous. Do you have use case in mind where it wouldn't be convenient to use from_file
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not in particular, but I suppose it would depend on the circumstances under which someone might want to create a new instrument without opening a PR for us. In a script or jupyter notebook, I don't think it would be difficult to keep a variable with the path to their YAML file around, but for anything more complicated (like software), I imagine it might be easier to register once and then simply call from_default
.
I am not sure this is important to have, but I wanted to check in case it is.
Resolves #9
Adds How-To Guides to the documentation.
TODO:
programmatic_query.rst
to reflect Add new PyChop version and create model versioning #16