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

Building a Sarracen DF is undocumented #50

Closed
JBorrow opened this issue Mar 16, 2023 · 3 comments · Fixed by #53
Closed

Building a Sarracen DF is undocumented #50

JBorrow opened this issue Mar 16, 2023 · 3 comments · Fixed by #53

Comments

@JBorrow
Copy link

JBorrow commented Mar 16, 2023

At present, it is not clear how to build a sarracen dataframe from e.g. a list of particle positions and smoothing lengths. I think this should be documented somewhere for people who do not want to load using pandas.

@JBorrow
Copy link
Author

JBorrow commented Mar 17, 2023

@ttricco
Copy link
Owner

ttricco commented Mar 17, 2023

@JBorrow If I am understanding your issue correctly, it is to add documentation on how to create a SarracenDataFrame without requiring reading the data from file. Our assumption has been that read_csv() would be leveraged for general reading of SPH data, but we can add documentation on how to create a SarracenDataFrame without requiring file reading.

@JBorrow
Copy link
Author

JBorrow commented Mar 17, 2023

Yes, I think it would also help to generally document the 'required' elements of the DF for visualisation, as this can help people who are developing on top of sarracen.

This is useful if e.g. you want to do isolated tests or visualise some initial conditions just after you finished creating them (or even, say, if you want to fill a SDF and use it to write out ICs for PHANTOM or some other code...)

@ttricco ttricco linked a pull request Apr 4, 2023 that will close this issue
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 a pull request may close this issue.

2 participants