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

include Gromacs extended ensemble data set #4

Closed
orbeckst opened this issue Oct 19, 2017 · 9 comments
Closed

include Gromacs extended ensemble data set #4

orbeckst opened this issue Oct 19, 2017 · 9 comments
Assignees
Milestone

Comments

@orbeckst
Copy link
Member

To test extended ensembles produced with Gromacs we need to include a data set. alchemistry/alchemlyb#14 includes a zip file (provided by @mrshirts ) that need to be analyzed, evaluated if it fits into alchemtest, and eventually included.

@orbeckst
Copy link
Member Author

@davidlmobley can you please add @trje3733 to the alchemistry org so that we can assign this issue to him? Thanks!

@davidlmobley
Copy link

Done. But, I also have you set as an administrator for alchemlyb and alchemtest so you should be able to add people to those directly via their settings without involving me.

@orbeckst
Copy link
Member Author

orbeckst commented Nov 14, 2017 via email

@mrshirts
Copy link

We are developing 4-5 tests that handle different possible cases. Should each of these tests each be it's own directory, or be subdirectories of a single one? With only one example so far, it's hard to see what the directory structure should be.

@orbeckst
Copy link
Member Author

The directory structure is flexible. The main thing is to make sure that you define good accessor functions.

Because it is Gromacs it should go under gmx and I would do something like

   gmx/
           benzene/             already there, simple TI and (M)BAR
           extended/            or whatever you deem a good name
                  case_1/
                  case_2/         ... 

In gmx/access.py I would add a accessor functions such as load_extended_case_1() etc. (We could modularize more but this might become overkill.)

Or do you think it will work better in some other way?

@orbeckst
Copy link
Member Author

Btw, the amber test files now follow a similar pattern, see https://github.com/alchemistry/alchemtest/tree/master/src/alchemtest/amber

@trje3733
Copy link
Collaborator

Have I been added to alchemtest yet? If not, could I be added soon?

@orbeckst
Copy link
Member Author

@trje3733 I thought you had been added to the org but I didn't see you there so I sent you invites as "collaborator" for alchemlyb and alchemtest. Let me know if they got stuck somewhere.

@orbeckst
Copy link
Member Author

@trje3733 , for the development process see https://github.com/alchemistry/alchemlyb/wiki/Developer-Guide and create a PR. Thanks!

orbeckst added a commit that referenced this issue Nov 29, 2017
- include extended ensemble test cases from #4 in gmx.rst
- added sub-headings to distinguish Simple TI/FEP and Extended ensemble
  test data (note: do not use ==== underline because that is used in
  descr.rst, use --- over+underline)
orbeckst added a commit that referenced this issue Nov 30, 2017
* display extended ensemble data in docs
  - include extended ensemble test cases from #4 in gmx.rst
  - added sub-headings to distinguish Simple TI/FEP and Extended ensemble
    test data (note: do not use ==== underline because that is used in
    descr.rst, use --- over+underline)
* small reST fixes in extended ensemble descriptions
* Fixes so that the docs build without issues. For instance, make the citation markers unique.
@orbeckst orbeckst added this to the release 0.2.0 milestone Jan 17, 2018
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

4 participants