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

Plans for this repo #1

Open
mattwthompson opened this issue Oct 17, 2019 · 2 comments
Open

Plans for this repo #1

mattwthompson opened this issue Oct 17, 2019 · 2 comments

Comments

@mattwthompson
Copy link
Member

I have a few topics I would like some input on:

  1. I would like these examples removed from the main repo but it to still be tested with these examples in CI as a separate build in AZP. This would allow us to maintain some higher-level testing while removing some maintenance burden in the main repo.

  2. I would also like these run independently as cron jobs, probably once daily.

  3. Should this repo be distributed as a package? For testing purposes, I think we can just clone and run a script to execute all notebooks. I could see benefits to distributing it on pip and/or anaconda but it's not really a package/library/stand-alone software.

  4. How aggressive can we be in removing examples from the main repo? I would like them out sooner than later, but maybe we should have a deprecation period.

  5. Should these examples be distributed as scripts, notebooks, or both? My vote is for notebooks only. It looks like these were originally scripts but mirrored into notebooks a few years ago (mosdef-hub/mbuild@bcd98ac)

  6. Should we mirror this process in foyer? I see envision foyer examples to be comparatively light, and there is also some example-like documentation (https://github.com/mosdef-hub/forcefield_template, https://github.com/mosdef-hub/foyer_tutorials). The examples we currently have are pretty sparse (https://github.com/mosdef-hub/foyer/tree/90acba0d5ebb9df248eccf58b783d1e29bc6b57a/foyer/examples / https://github.com/mosdef-hub/foyer/tree/90acba0d5ebb9df248eccf58b783d1e29bc6b57a/examples)

@mattwthompson
Copy link
Member Author

Another idea would be to move it "up" one folder, so it's at root and not "inside" of mbuild. This could either keep them in the main repo or be set up as a git submodule that points here.

@mattwthompson
Copy link
Member Author

  1. (and 4.) After Remove examples mbuild#658, examples are no longer in the main repo, but the AZP build is not yet set up.

  2. I will set this up after Try setting up travis #2

  3. I still think no

\

  1. To-do

@rmatsum836 rmatsum836 mentioned this issue Jan 24, 2020
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

1 participant