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

Distribute the various external files referenced throughout the tutorials #22

Open
BvB93 opened this issue May 28, 2021 · 2 comments
Open
Labels
enhancement New feature or request

Comments

@BvB93
Copy link
Member

BvB93 commented May 28, 2021

A number of .xyz, .psf and other files are currently referenced throughout the tutorials.
Ideally we'd distribute them such that users can more easilly explore the examples.

@BvB93 BvB93 added the enhancement New feature or request label May 28, 2021
@BvB93
Copy link
Member Author

BvB93 commented May 28, 2021

Proposed distribution model: add a dedicated module for each tutorial wherefrom one can import a str or pathlib.Path` pointing to the relevant external files.

Examples

For Preparing a Simulation Box:

>>> from tutorials.simulation_box import box_ordered_xyz

>>> print(repr(box_ordered_xyz))
".../box_ordered.xyz"

@BvB93
Copy link
Member Author

BvB93 commented May 28, 2021

Or store them in dictionaries perhaps?

>>> import tutorials

>>> print(tutorials.simulation_box)
{"box_ordered.xyz": ".../box_ordered.xyz"}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant