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

Document how to use pyposeidon with an existing schism model that has not been generated by pyposeidon #133

Open
pmav99 opened this issue Apr 19, 2023 · 2 comments

Comments

@pmav99
Copy link
Collaborator

pmav99 commented Apr 19, 2023

This is how it's done:

import pyposeidon

params = {
    "solver_name": "schism",
    "rpath": "/path/to/model/directory/",
}

model = pyposeidon.model.set(**params)
model.results()

The question is where in the docs, should we put this

@brey
Copy link
Collaborator

brey commented May 9, 2023

@pmav99 It is already there at the bottom of https://pyposeidon.readthedocs.io/en/latest/model.html.

We can add your snippet above there.

Noted for the docs update.

@pmav99
Copy link
Collaborator Author

pmav99 commented May 9, 2023

If memory serves, the call to .results() is kind of mandatory and it is not mentioned in the docs. Or at least, after skimming through the docs, it was not apparent to me that I should call it.

That's why I opened the ticket.

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

2 participants