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

task: update docs to include usage of ImodModel object API #14

Closed
alisterburt opened this issue May 16, 2024 · 4 comments
Closed

task: update docs to include usage of ImodModel object API #14

alisterburt opened this issue May 16, 2024 · 4 comments

Comments

@alisterburt
Copy link
Member

alisterburt commented May 16, 2024 •
edited
Loading

I noticed the docs are missing the ImodModel API example present in the README, would be good to add
@alisterburt alisterburt changed the title task: update docs to include usage of `Imod task: update docs to include usage of ImodModel object API May 16, 2024
@braxtonowens
Copy link
Collaborator

I have been working on this. I do have a question however.

Why is imat an attribute of ImodModel? Should it instead be an attribute of ImodModel.Object?

I ask this because I thought that IMAT was a per-object attribute.

image

Please correct me if I am wrong. I personally have never used information from "imat".

@alisterburt
Copy link
Member Author

I didn't implement this and have never used the functionality myself, you're probably right! I'd gladly accept a PR to fix :)

@alisterburt
Copy link
Member Author

really appreciate your enthusiasm here!!

@alisterburt
Copy link
Member Author

closed by #19

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@alisterburt @braxtonowens