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

add development instructions #988

Merged
merged 26 commits into from
Sep 25, 2024
Merged

add development instructions #988

merged 26 commits into from
Sep 25, 2024

Conversation

rvhonorato
Copy link
Member

@rvhonorato rvhonorato commented Aug 30, 2024

This PR adds instructions on how to develop haddock3 and also updates the setup.py to include a CustomDevelop instruction class

@rvhonorato rvhonorato self-assigned this Aug 30, 2024
@rvhonorato rvhonorato added the documentation Improve docs label Aug 30, 2024
@rvhonorato rvhonorato closed this Aug 30, 2024
@rvhonorato rvhonorato deleted the dev-docs branch August 30, 2024 10:31
@amjjbonvin amjjbonvin restored the dev-docs branch August 30, 2024 10:39
@amjjbonvin amjjbonvin reopened this Aug 30, 2024
@rvhonorato rvhonorato removed their assignment Aug 30, 2024
VGPReys
VGPReys previously approved these changes Sep 10, 2024
@rvhonorato rvhonorato marked this pull request as draft September 10, 2024 12:19
@rvhonorato
Copy link
Member Author

After irl discussion it was decided we need to also add a "Developing HADDOCK3 in a HPC environment" section

@rvhonorato
Copy link
Member Author

This will change after #1013 - best to solve that one first

amjjbonvin and others added 2 commits September 22, 2024 18:23
Added a short section about HPC environment
DEVELOPMENT.md Outdated Show resolved Hide resolved
@rvhonorato rvhonorato requested a review from a team September 23, 2024 10:17
Added not for brew install mpi4py on OSX
@amjjbonvin
Copy link
Member

amjjbonvin commented Sep 24, 2024 via email

DEVELOPMENT.md Outdated Show resolved Hide resolved
Co-authored-by: Victor Reys <132575181+VGPReys@users.noreply.github.com>
@amjjbonvin
Copy link
Member

Getting errors in the tests: FAILED tests/test_cli_restraints.py::test_restrain_bodies - AssertionError: assert 'assign (segi...1.582 0.0 0.0' == 'assign (segi...6.542 0.0 0.0' FAILED tests/test_cli_restraints.py::test_restrain_bodies_exclude - AssertionError: assert 'assign (segi...7.660 0.0 0.0' == 'assign (segi...5.187 0.0 0

As the residues are randomly selected, could this be the problem? E.g. a different pair is selected because of different random numbers or related?

@amjjbonvin
Copy link
Member

And another issue with the instructions is that we are missing a step about CNS - without the executable the tests will fail.

@VGPReys
Copy link
Contributor

VGPReys commented Sep 24, 2024

Also missing instructions for the softlink to CNS ?

ln -s /path/to/cns-os-cpu.exe src/haddock/bin/cns

@rvhonorato
Copy link
Member Author

Getting errors in the tests: FAILED tests/test_cli_restraints.py::test_restrain_bodies - AssertionError: assert 'assign (segi...1.582 0.0 0.0' == 'assign (segi...6.542 0.0 0.0' FAILED tests/test_cli_restraints.py::test_restrain_bodies_exclude - AssertionError: assert 'assign (segi...7.660 0.0 0.0' == 'assign (segi...5.187 0.0 0

As the residues are randomly selected, could this be the problem? E.g. a different pair is selected because of different random numbers or related?

Unclear to me how the different installations would fail this test.

@rvhonorato
Copy link
Member Author

Also missing instructions for the softlink to CNS ?

ln -s /path/to/cns-os-cpu.exe src/haddock/bin/cns

Why have a link and not use the pre-compiled ones?

@rvhonorato rvhonorato marked this pull request as draft September 24, 2024 14:47
@rvhonorato rvhonorato changed the title add DEVELOPMENT.md add development instructions Sep 24, 2024
@rvhonorato
Copy link
Member Author

@haddocking/haddock-developers I have updated the instructions, please try again - make sure all your system dependencies are installed.

rvhonorato and others added 4 commits September 24, 2024 17:33
The exact path might vary depending on the system/installation
Copy link
Member

@amjjbonvin amjjbonvin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now working as a charm!

@rvhonorato rvhonorato marked this pull request as ready for review September 24, 2024 19:12
@rvhonorato rvhonorato merged commit f5ff282 into main Sep 25, 2024
2 checks passed
@rvhonorato rvhonorato deleted the dev-docs branch September 25, 2024 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants