haddock3 2024.10.0b6__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- haddock3-2024.10.0b6/CHANGELOG.md +3 -0
- haddock3-2024.10.0b6/CITING.md +8 -0
- haddock3-2024.10.0b6/CODE_OF_CONDUCT.md +132 -0
- haddock3-2024.10.0b6/CONTRIBUTING.md +331 -0
- haddock3-2024.10.0b6/DEVELOPMENT.md +103 -0
- haddock3-2024.10.0b6/DISCLAIMER.md +37 -0
- haddock3-2024.10.0b6/LICENSE +201 -0
- haddock3-2024.10.0b6/MANIFEST.in +31 -0
- haddock3-2024.10.0b6/PKG-INFO +169 -0
- haddock3-2024.10.0b6/README.md +113 -0
- haddock3-2024.10.0b6/docs/CNS.md +234 -0
- haddock3-2024.10.0b6/docs/INSTALL.md +106 -0
- haddock3-2024.10.0b6/docs/USAGE.md +48 -0
- haddock3-2024.10.0b6/docs/citing.rst +2 -0
- haddock3-2024.10.0b6/docs/conf.py +124 -0
- haddock3-2024.10.0b6/docs/contributing.rst +2 -0
- haddock3-2024.10.0b6/docs/examples.md +180 -0
- haddock3-2024.10.0b6/docs/figs/HADDOCK2-stages.png +0 -0
- haddock3-2024.10.0b6/docs/figs/HADDOCK3-logo.png +0 -0
- haddock3-2024.10.0b6/docs/figs/HADDOCK3-workflow-scheme.png +0 -0
- haddock3-2024.10.0b6/docs/index.rst +36 -0
- haddock3-2024.10.0b6/docs/intro.md +130 -0
- haddock3-2024.10.0b6/docs/modules/index.rst +41 -0
- haddock3-2024.10.0b6/docs/reference/index.rst +11 -0
- haddock3-2024.10.0b6/docs/testing/index.rst +7 -0
- haddock3-2024.10.0b6/docs/testing/integration_tests.md +141 -0
- haddock3-2024.10.0b6/docs/tutorials/benchmark.md +113 -0
- haddock3-2024.10.0b6/docs/tutorials/continuing_runs.md +170 -0
- haddock3-2024.10.0b6/docs/tutorials/index.rst +24 -0
- haddock3-2024.10.0b6/docs/tutorials/mpi.md +61 -0
- haddock3-2024.10.0b6/docs/tutorials/user_config.rst +187 -0
- haddock3-2024.10.0b6/pyproject.toml +98 -0
- haddock3-2024.10.0b6/setup.cfg +4 -0
- haddock3-2024.10.0b6/setup.py +145 -0
- haddock3-2024.10.0b6/src/haddock/__init__.py +47 -0
- haddock3-2024.10.0b6/src/haddock/clis/__init__.py +8 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli.py +209 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_analyse.py +662 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_bm.py +699 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_cfg.py +236 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_clean.py +116 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_cp.py +179 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_dmn.py +333 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_mpi.py +123 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_pp.py +168 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_re.py +60 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_restraints.py +120 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_score.py +288 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_traceback.py +370 -0
- haddock3-2024.10.0b6/src/haddock/clis/cli_unpack.py +138 -0
- haddock3-2024.10.0b6/src/haddock/clis/re/__init__.py +1 -0
- haddock3-2024.10.0b6/src/haddock/clis/re/clustfcc.py +215 -0
- haddock3-2024.10.0b6/src/haddock/clis/re/clustrmsd.py +289 -0
- haddock3-2024.10.0b6/src/haddock/clis/re/score.py +148 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/__init__.py +0 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/active_passive_to_ambig.py +69 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/calc_accessibility.py +414 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/naccess.config +414 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/passive_from_active.py +67 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/restrain_bodies.py +72 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/validate_tbl.py +58 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/webservice.py +300 -0
- haddock3-2024.10.0b6/src/haddock/clis/restraints/z_surface_restraints.py +745 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/boxtyp20.pdb +658 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/carbohydrate.param +251 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/carbohydrate.top +2794 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dmso.pdb +852 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna-rna-1.3.link +88 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna-rna-CG-MARTINI-2-1p-break.top +19 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna-rna-CG-MARTINI-2-1p.link +48 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna-rna-CG-MARTINI-2-1p.param +1467 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna-rna-CG-MARTINI-2-1p.top +448 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna-rna-allatom-hj-opls-1.3.param +1244 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna-rna-allatom-hj-opls-1.3.top +1086 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna-rna-pho-1.3.link +87 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/dna_break.top +18 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/fragment_probes.param +519 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/fragment_probes.top +2208 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/heme.pdb +87 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/heme.psf +525 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/hemeB.pdb +77 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/hemeB.psf +1013 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/hemes-allhdg.param +223 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/hemes-allhdg.top +708 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/hemes.pep +0 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_0 +3 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_1 +3 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_10 +30 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_11 +33 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_12 +36 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_13 +39 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_14 +42 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_15 +45 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_16 +48 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_17 +51 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_18 +54 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_19 +57 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_2 +6 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_20 +60 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_21 +63 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_22 +66 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_23 +69 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_24 +72 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_25 +75 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_26 +78 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_27 +81 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_28 +84 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_29 +87 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_3 +9 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_30 +90 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_31 +93 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_32 +96 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_33 +99 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_34 +102 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_35 +105 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_36 +108 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_37 +111 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_38 +114 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_39 +117 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_4 +12 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_40 +120 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_41 +123 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_42 +126 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_43 +129 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_44 +132 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_45 +135 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_46 +138 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_47 +141 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_48 +144 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_49 +147 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_5 +15 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_50 +150 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_6 +18 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_7 +21 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_8 +24 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/initial_positions/trans_vector_9 +27 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/ion.param +124 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/ion.top +543 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/ligand.param +1 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/ligand.pep +0 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/ligand.top +1 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/metalcenter.tbl +2 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/par_axis.pro +21 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/par_axis_dani.pro +19 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-CG-Martini-2-2.link +1615 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-CG-Martini-2-2.param +47164 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-CG-Martini-2-2.top +520 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-CG-Martini.link +1615 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-CG-Martini.param +60603 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-CG-Martini.top +506 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-allhdg5-4-noCter.link +2557 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-allhdg5-4-noNter.link +2553 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-allhdg5-4-noter.link +2506 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-allhdg5-4.link +2604 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-allhdg5-4.param +2002 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/protein-allhdg5-4.top +3431 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/scatter.lib +488 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/shape.link +6 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/shape.param +8 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/shape.top +16 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/solvent-allhdg5-4.param +39 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/solvent-allhdg5-4.top +170 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/tensor.pdb +45 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/tensor.psf +207 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/tensor_dani.pdb +25 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/tensor_dani.psf +132 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/tensor_para.pdb +45 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/tensor_para.psf +217 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/top_axis.pro +55 -0
- haddock3-2024.10.0b6/src/haddock/cns/toppar/top_axis_dani.pro +28 -0
- haddock3-2024.10.0b6/src/haddock/core/__init__.py +3 -0
- haddock3-2024.10.0b6/src/haddock/core/cns_paths.py +88 -0
- haddock3-2024.10.0b6/src/haddock/core/defaults.py +59 -0
- haddock3-2024.10.0b6/src/haddock/core/exceptions.py +79 -0
- haddock3-2024.10.0b6/src/haddock/core/mandatory.yaml +18 -0
- haddock3-2024.10.0b6/src/haddock/core/optional.yaml +24 -0
- haddock3-2024.10.0b6/src/haddock/core/supported_molecules.py +483 -0
- haddock3-2024.10.0b6/src/haddock/core/typing.py +197 -0
- haddock3-2024.10.0b6/src/haddock/deps/contact_fcc.cpp +124 -0
- haddock3-2024.10.0b6/src/haddock/deps/fast-rmsdmatrix.c +883 -0
- haddock3-2024.10.0b6/src/haddock/fcc/__init__.py +0 -0
- haddock3-2024.10.0b6/src/haddock/fcc/calc_fcc_matrix.py +96 -0
- haddock3-2024.10.0b6/src/haddock/fcc/cluster_fcc.py +187 -0
- haddock3-2024.10.0b6/src/haddock/gear/__init__.py +7 -0
- haddock3-2024.10.0b6/src/haddock/gear/clean_steps.py +243 -0
- haddock3-2024.10.0b6/src/haddock/gear/config.py +339 -0
- haddock3-2024.10.0b6/src/haddock/gear/expandable_parameters.py +934 -0
- haddock3-2024.10.0b6/src/haddock/gear/extend_run.py +283 -0
- haddock3-2024.10.0b6/src/haddock/gear/greetings.py +112 -0
- haddock3-2024.10.0b6/src/haddock/gear/haddockmodel.py +63 -0
- haddock3-2024.10.0b6/src/haddock/gear/known_cns_errors.py +183 -0
- haddock3-2024.10.0b6/src/haddock/gear/parameters.py +18 -0
- haddock3-2024.10.0b6/src/haddock/gear/prepare_run.py +1471 -0
- haddock3-2024.10.0b6/src/haddock/gear/preprocessing.py +1090 -0
- haddock3-2024.10.0b6/src/haddock/gear/restart_run.py +67 -0
- haddock3-2024.10.0b6/src/haddock/gear/validations.py +107 -0
- haddock3-2024.10.0b6/src/haddock/gear/yaml2cfg.py +287 -0
- haddock3-2024.10.0b6/src/haddock/gear/zerofill.py +135 -0
- haddock3-2024.10.0b6/src/haddock/libs/__init__.py +3 -0
- haddock3-2024.10.0b6/src/haddock/libs/assets/__init__.py +12 -0
- haddock3-2024.10.0b6/src/haddock/libs/assets/index.css +1 -0
- haddock3-2024.10.0b6/src/haddock/libs/assets/report.bundle.js +5263 -0
- haddock3-2024.10.0b6/src/haddock/libs/libalign.py +1376 -0
- haddock3-2024.10.0b6/src/haddock/libs/libcli.py +105 -0
- haddock3-2024.10.0b6/src/haddock/libs/libclust.py +313 -0
- haddock3-2024.10.0b6/src/haddock/libs/libcns.py +397 -0
- haddock3-2024.10.0b6/src/haddock/libs/libfcc.py +233 -0
- haddock3-2024.10.0b6/src/haddock/libs/libfunc.py +85 -0
- haddock3-2024.10.0b6/src/haddock/libs/libhpc.py +406 -0
- haddock3-2024.10.0b6/src/haddock/libs/libinteractive.py +202 -0
- haddock3-2024.10.0b6/src/haddock/libs/libio.py +615 -0
- haddock3-2024.10.0b6/src/haddock/libs/liblog.py +83 -0
- haddock3-2024.10.0b6/src/haddock/libs/libmath.py +27 -0
- haddock3-2024.10.0b6/src/haddock/libs/libmpi.py +47 -0
- haddock3-2024.10.0b6/src/haddock/libs/libontology.py +250 -0
- haddock3-2024.10.0b6/src/haddock/libs/libparallel.py +208 -0
- haddock3-2024.10.0b6/src/haddock/libs/libpdb.py +298 -0
- haddock3-2024.10.0b6/src/haddock/libs/libplots.py +1575 -0
- haddock3-2024.10.0b6/src/haddock/libs/librestraints.py +688 -0
- haddock3-2024.10.0b6/src/haddock/libs/libstructure.py +44 -0
- haddock3-2024.10.0b6/src/haddock/libs/libsubprocess.py +275 -0
- haddock3-2024.10.0b6/src/haddock/libs/libtimer.py +75 -0
- haddock3-2024.10.0b6/src/haddock/libs/libutil.py +381 -0
- haddock3-2024.10.0b6/src/haddock/libs/libworkflow.py +179 -0
- haddock3-2024.10.0b6/src/haddock/modules/__init__.py +517 -0
- haddock3-2024.10.0b6/src/haddock/modules/_template_cat/README.md +30 -0
- haddock3-2024.10.0b6/src/haddock/modules/_template_cat/_template_mod/__init__.py +142 -0
- haddock3-2024.10.0b6/src/haddock/modules/_template_cat/_template_mod/defaults.yaml +106 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/__init__.py +53 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/alascan/__init__.py +106 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/alascan/defaults.yaml +52 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/alascan/scan.py +552 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/caprieval/__init__.py +185 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/caprieval/capri.py +1192 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/caprieval/defaults.yaml +199 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/clustfcc/__init__.py +205 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/clustfcc/clustfcc.py +206 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/clustfcc/defaults.yaml +59 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/clustrmsd/__init__.py +188 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/clustrmsd/clustrmsd.py +400 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/clustrmsd/defaults.yaml +70 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/contactmap/__init__.py +130 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/contactmap/contmap.py +2392 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/contactmap/defaults.yaml +120 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/ilrmsdmatrix/__init__.py +371 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/ilrmsdmatrix/defaults.yaml +71 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/ilrmsdmatrix/ilrmsd.py +110 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/rmsdmatrix/__init__.py +228 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/rmsdmatrix/defaults.yaml +45 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/rmsdmatrix/rmsd.py +124 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/seletop/__init__.py +65 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/seletop/defaults.yaml +10 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/seletopclusts/__init__.py +89 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/seletopclusts/defaults.yaml +33 -0
- haddock3-2024.10.0b6/src/haddock/modules/analysis/seletopclusts/seletopclusts.py +241 -0
- haddock3-2024.10.0b6/src/haddock/modules/base_cns_module.py +154 -0
- haddock3-2024.10.0b6/src/haddock/modules/defaults.yaml +154 -0
- haddock3-2024.10.0b6/src/haddock/modules/extras/__init__.py +6 -0
- haddock3-2024.10.0b6/src/haddock/modules/extras/exit/__init__.py +68 -0
- haddock3-2024.10.0b6/src/haddock/modules/extras/exit/defaults.yaml +10 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/__init__.py +1 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/__init__.py +142 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/calc_free-ene.cns +24 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/contactairs.cns +27 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/def_solv_param.cns +105 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/dna-rna_restraints.cns +424 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/emref.cns +467 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/flex_segment_back.cns +58 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/flexauto-neighbors.cns +42 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/print_coorheader.cns +321 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/protein-ss-restraints-all.cns +88 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/protein-ss-restraints-alpha-beta.cns +128 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/protein-ss-restraints-alpha.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/read_data.cns +81 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/read_noes.cns +65 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/read_param.cns +64 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/restrain-ions.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/scale_inter.cns +45 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/scale_inter_final.cns +39 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/scale_intra_only.cns +36 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/setflags.cns +21 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/cns/symmultimer.cns +677 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/emref/defaults.yaml +4652 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/__init__.py +158 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/calc_free-ene.cns +24 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/check-homomers.cns +56 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/cm-restraints.cns +131 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/contactairs.cns +27 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/covalions.cns +83 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/def_solv_param.cns +105 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/dna-rna_restraints.cns +424 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/flex_segment.cns +32 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/flex_segment_back.cns +58 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/flex_segment_side.cns +61 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/flexauto-neighbors.cns +42 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/flexref.cns +592 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/numtrees.cns +83 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/print_coorheader.cns +321 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/protein-ss-restraints-all.cns +88 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/protein-ss-restraints-alpha-beta.cns +128 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/protein-ss-restraints-alpha.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/random_rotations.cns +180 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/read_data.cns +81 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/read_noes.cns +65 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/read_param.cns +64 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/restrain-ions.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/sa_ltad_cool1.cns +130 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/sa_ltad_cool2.cns +130 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/sa_ltad_cool3.cns +128 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/sa_ltad_hightemp.cns +65 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/scale_inter.cns +45 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/scale_inter_final.cns +39 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/scale_inter_only.cns +41 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/scale_intra_only.cns +36 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/separate.cns +236 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/setflags.cns +24 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/symmultimer.cns +677 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/cns/torsiontop.cns +108 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/flexref/defaults.yaml +5195 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/__init__.py +156 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/calc_free-ene.cns +24 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/cm-restraints.cns +144 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/contactairs.cns +27 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/def_solv_param.cns +105 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/dna-rna_restraints.cns +424 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/flex_segment_back.cns +56 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/flex_segment_side.cns +47 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/flexauto-neighbors.cns +42 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/generate_dmso.cns +121 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/generate_water.cns +122 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/mdref.cns +593 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/print_coorheader.cns +321 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/protein-ss-restraints-all.cns +88 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/protein-ss-restraints-alpha-beta.cns +128 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/protein-ss-restraints-alpha.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/read_data.cns +81 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/read_noes.cns +65 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/read_param.cns +64 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/restrain-ions.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/scale_inter.cns +45 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/scale_inter_final.cns +39 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/scale_intra_only.cns +36 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/setflags.cns +21 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/cns/symmultimer.cns +677 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/mdref/defaults.yaml +4751 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/openmm/__init__.py +187 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/openmm/defaults.yaml +302 -0
- haddock3-2024.10.0b6/src/haddock/modules/refinement/openmm/openmm.py +970 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/__init__.py +1 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/gdock/__init__.py +152 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/gdock/defaults.yaml +8 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/lightdock/__init__.py +160 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/lightdock/defaults.yaml +134 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/__init__.py +248 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/bestener.cns +108 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/bsa.cns +52 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/charge-beads-interactions.cns +43 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/check-homomers.cns +56 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/cm-restraints.cns +131 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/def_solv_param.cns +105 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/get_random_rotation.cns +91 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/print_coorheader.cns +321 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/random_rotations.cns +180 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/randomairs.cns +246 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/read_noes.cns +65 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/read_param.cns +64 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/rigidbody.cns +588 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/rotation180.cns +80 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/scale_inter_final.cns +39 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/scale_inter_mini.cns +37 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/scale_inter_only.cns +41 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/scale_intra_only.cns +36 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/separate.cns +236 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/surf-restraints.cns +69 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/cns/symmultimer.cns +677 -0
- haddock3-2024.10.0b6/src/haddock/modules/sampling/rigidbody/defaults.yaml +4496 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/__init__.py +166 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/__init__.py +105 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/cns/calc_free-ene.cns +24 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/cns/def_solv_param.cns +105 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/cns/emscoring.cns +200 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/cns/print_coorheader.cns +394 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/cns/read_param.cns +64 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/cns/restrain-ions.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/cns/scale_inter_final.cns +39 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/cns/scale_intra_only.cns +36 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/emscoring/defaults.yaml +305 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/__init__.py +105 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/calc_free-ene.cns +24 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/contactairs.cns +27 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/def_solv_param.cns +105 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/dna-rna_restraints.cns +424 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/flex_segment_back.cns +26 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/flex_segment_side.cns +29 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/flexauto-neighbors.cns +45 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/generate_dmso.cns +121 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/generate_water.cns +122 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/mdscoring.cns +447 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/print_coorheader.cns +394 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/protein-ss-restraints-all.cns +88 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/protein-ss-restraints-alpha-beta.cns +128 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/protein-ss-restraints-alpha.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/read_param.cns +64 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/restrain-ions.cns +109 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/scale_inter_final.cns +39 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/scale_intra_only.cns +36 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/cns/setflags.cns +21 -0
- haddock3-2024.10.0b6/src/haddock/modules/scoring/mdscoring/defaults.yaml +455 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/__init__.py +1 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/__init__.py +334 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/auto-his.cns +141 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/bondglycans.cns +676 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/build-missing.cns +296 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/coval-ace-cys.cns +57 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/covalheme.cns +125 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/dna_break.cns +82 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/generate-topology.cns +809 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/patch-bb-cg.cns +240 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/patch-types-cg.cns +83 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/cns/prot_break.cns +141 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topoaa/defaults.yaml +192 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topocg/__init__.py +12 -0
- haddock3-2024.10.0b6/src/haddock/modules/topology/topocg/defaults.yaml +1 -0
- haddock3-2024.10.0b6/src/haddock3.egg-info/PKG-INFO +169 -0
- haddock3-2024.10.0b6/src/haddock3.egg-info/SOURCES.txt +469 -0
- haddock3-2024.10.0b6/src/haddock3.egg-info/dependency_links.txt +1 -0
- haddock3-2024.10.0b6/src/haddock3.egg-info/entry_points.txt +15 -0
- haddock3-2024.10.0b6/src/haddock3.egg-info/requires.txt +29 -0
- haddock3-2024.10.0b6/src/haddock3.egg-info/top_level.txt +1 -0
- haddock3-2024.10.0b6/varia/cns1.3/README.md +41 -0
- haddock3-2024.10.0b6/varia/cns1.3/instlib/machine/supported/arm-aarch64-linux/machine_f.f +892 -0
- haddock3-2024.10.0b6/varia/cns1.3/instlib/machine/supported/intel-x86_64bit-linux/machine_f.f +892 -0
- haddock3-2024.10.0b6/varia/cns1.3/instlib/machine/supported/linux/machine_f.f +892 -0
- haddock3-2024.10.0b6/varia/cns1.3/instlib/machine/supported/mac-arm-darwin/machine_f.f +892 -0
- haddock3-2024.10.0b6/varia/cns1.3/instlib/machine/supported/mac-intel-darwin/machine_f.f +892 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/cns.f +567 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/cns.inc +55 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/cnst.inc +130 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/collapse.inc +18 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/collapse_rgyr.f +200 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/connect.f +413 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/cstran.f +927 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/ener.inc +128 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/energy.f +810 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/fantacross.f +481 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/fantalin.f +1680 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/fantaxplor.inc +8 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/genic.f +1819 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/initia.f +66 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/machvar.f +70 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/param.inc +117 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/rtf.inc +126 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/segmnt.f +1025 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/selrpn.f +1773 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/sup2.inc +72 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/supccr.inc +73 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/vector.f +2622 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/version.inc +14 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xangle.f +778 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xangle.inc +59 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xccr.f +906 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xccr.inc +58 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xdipo_pcs.f +1544 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xdipo_pcs.inc +61 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xdipo_rdc.f +1221 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xdipo_rdc.inc +61 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xfantaccr.f +137 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xfantadipo.f +244 -0
- haddock3-2024.10.0b6/varia/cns1.3/source/xt1dist.f +216 -0
- haddock3-2024.10.0b6/varia/lmod/README.md +26 -0
- haddock3-2024.10.0b6/varia/lmod/haddock3/3.0.0.lua +32 -0
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Citing
|
|
2
|
+
|
|
3
|
+
Cite HADDOCK3 with the following:
|
|
4
|
+
|
|
5
|
+
1. HADDOCK3, Bonvin's Lab, https://github.com/haddocking/haddock3, 2022.
|
|
6
|
+
2. Dominguez, C., Boelens, R. & Bonvin, A. M. J. J. HADDOCK: a protein-protein docking approach based on biochemical or biophysical information. J Am Chem Soc 125, 1731–1737 (2003).
|
|
7
|
+
|
|
8
|
+
Developed with financial support from the Horizon 2020 [BioExcel CoE](https://www.bioexcel.eu) project [823830](https://cordis.europa.eu/project/id/823830)
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
- Demonstrating empathy and kindness toward other people
|
|
21
|
+
- Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
- Giving and gracefully accepting constructive feedback
|
|
23
|
+
- Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
- Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
- The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
- Public or private harassment
|
|
34
|
+
- Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
- Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
`haddocking@gmail.com`.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by
|
|
122
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
123
|
+
|
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
127
|
+
|
|
128
|
+
[homepage]: https://www.contributor-covenant.org
|
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
130
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
131
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
132
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
@@ -0,0 +1,331 @@
|
|
|
1
|
+
# Contributing to HADDOCK3
|
|
2
|
+
|
|
3
|
+
Welcome, we made many efforts to facilitate your contribution to this
|
|
4
|
+
fantastic project. There are several ways to contribute:
|
|
5
|
+
|
|
6
|
+
* you can improve tutorials and/or documentation
|
|
7
|
+
* improve the code itself (maybe you even found some bug :bug:?)
|
|
8
|
+
* improve error messages so they become clearer
|
|
9
|
+
* add a new simulation module altogether
|
|
10
|
+
* write more unittests (we dare you to do that :godmode:)
|
|
11
|
+
|
|
12
|
+
Before attempting any development, please install HADDOCK3 following the
|
|
13
|
+
instructions in the [INSTALL](docs/INSTALL.md) file. Afterwards, follow the
|
|
14
|
+
instructions in this file.
|
|
15
|
+
|
|
16
|
+
## 1. Contributing new code
|
|
17
|
+
|
|
18
|
+
HADDOCK3 has two main testing workflows. Here, within the repository, we
|
|
19
|
+
test the HADDOCK3's Python shell, code style, and package building. Our
|
|
20
|
+
Continuous Integration (CI) pipeline is based on
|
|
21
|
+
[tox][tox] and GitHub Actions. We will
|
|
22
|
+
explain you how to use them.
|
|
23
|
+
|
|
24
|
+
To contribute to the HADDOCK3's Python shell, follow these steps:
|
|
25
|
+
|
|
26
|
+
1. [Fork][fork] the HADDOCK3 repository
|
|
27
|
+
2. Create a new branch in your fork (`git checkout -b <new_branch_name>`)
|
|
28
|
+
3. Develop your code and tests:
|
|
29
|
+
|
|
30
|
+
1. HADDOCK3 source is in `src/haddock`. Always implement code in
|
|
31
|
+
the lowest Python version supported (this case is 3.9).
|
|
32
|
+
2. Tests sit in the `tests/` folder. Use
|
|
33
|
+
[pytest](https://docs.pytest.org/en/6.2.x/) for testing.
|
|
34
|
+
3. See more details on how to contribute with code and tests in the
|
|
35
|
+
subheadings below.
|
|
36
|
+
|
|
37
|
+
4. While you are developing (or when you think you have finished), you can
|
|
38
|
+
(should) use our `tox` environments to test your code. Use the
|
|
39
|
+
following commands from the main repository folder:
|
|
40
|
+
|
|
41
|
+
1. `tox -e test` runs tests in current python version. If you tox
|
|
42
|
+
to report test names and status for every single test (high verbosity) use
|
|
43
|
+
`tox -e test -- -vv`.
|
|
44
|
+
2. `tox -e lint` shows you errors in the code style.
|
|
45
|
+
3. `tox -e build` simulates building the HADDOCK3 package.
|
|
46
|
+
4. Run the above altogether with the simple `tox` command
|
|
47
|
+
5. If you want to submit high-quality code, you may wish to run
|
|
48
|
+
`tox -e radon` to assess your code cyclomatic complexity.
|
|
49
|
+
|
|
50
|
+
5. You can work on these `tox` tests until they all pass green before
|
|
51
|
+
submitting your PR.
|
|
52
|
+
|
|
53
|
+
6. Check if your contribution fulfills the requeriments proposed in the
|
|
54
|
+
PR template, these are based on the experience of some developers to ensure the long-term
|
|
55
|
+
survival of the codebase. Suggestions are always welcomed.
|
|
56
|
+
|
|
57
|
+
7. We also have an `examples` folder with test cases that you can run
|
|
58
|
+
(should) to ensure the integrity of the python shell as a whole:
|
|
59
|
+
1. Navigate to any of the examples folder and run the `-test.cfg`
|
|
60
|
+
file (see [USAGE](USAGE.md)).
|
|
61
|
+
2. `*-test.cfg` runs are meant for testing purposes only. The
|
|
62
|
+
`examples/` folder also contain `*-full.cfg` files for production runs.
|
|
63
|
+
You don't need to run these for testin.
|
|
64
|
+
2. If you have a powerful computer and want to run all tests in a
|
|
65
|
+
row, navigate to the `examples` folder and run `python run_tests.py
|
|
66
|
+
-b`. The `-b` flag ensures the run will stop asap an error is found.
|
|
67
|
+
3. if your computer is not powerful enough, you can ask us to run
|
|
68
|
+
those tests once you submitted the pull request.
|
|
69
|
+
4. For example, the `docking-protein-protein-test.cfg` run in less
|
|
70
|
+
than 3 minutes on a `Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz` laptop
|
|
71
|
+
using 7 cores. All `-test.cfg` together take about 45 minutes.
|
|
72
|
+
|
|
73
|
+
8. Add a list of your new additions to the `CHANGELOG.md` file by
|
|
74
|
+
adding a new sub-header as described bellow. This is mandatory for `tox
|
|
75
|
+
-e build` to pass. Note this applies only after we have released the
|
|
76
|
+
stable `3.0.0` version.
|
|
77
|
+
|
|
78
|
+
```markdown
|
|
79
|
+
# Changelog
|
|
80
|
+
|
|
81
|
+
## new_version
|
|
82
|
+
|
|
83
|
+
* your change one
|
|
84
|
+
* your change two
|
|
85
|
+
|
|
86
|
+
(... the rest of the file ...)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
8. If you have difficulties with `tox`, let us know. These `tox` tests
|
|
90
|
+
are the same that run on the GitHub Actions once you send the PR. So,
|
|
91
|
+
sending the PR is another way to ensure all tests pass.
|
|
92
|
+
|
|
93
|
+
9. Submit your PR if you haven't done so yet :wink:
|
|
94
|
+
|
|
95
|
+
1. GitHub allows submitting "Draft PRs". You can use this
|
|
96
|
+
option to let us know you are working on some new good stuff so we
|
|
97
|
+
can help you from the beginning.
|
|
98
|
+
|
|
99
|
+
### 1.1 Contributing with code (additional details)
|
|
100
|
+
|
|
101
|
+
**You should also know that...** HADDOCK3 folders, files, and code
|
|
102
|
+
follow a well defined structure with very specific patterns. Inside each
|
|
103
|
+
source folder you will (likely) find a `README` file describing the
|
|
104
|
+
structure of the folder and presenting guidelines on how to better
|
|
105
|
+
contribute to that folder and respective files. Summarizing here:
|
|
106
|
+
|
|
107
|
+
* New command-line clients go in the `clis/` folder. See how the current
|
|
108
|
+
clients here created and use that as a template. Remember to update also the
|
|
109
|
+
`setup.py` file.
|
|
110
|
+
* Add any new functions that you foresee are general and
|
|
111
|
+
could serve different places in the code to the `libs/` folder. Find a
|
|
112
|
+
`lib*.py` files that would serve your purpuses, otherwise create a new
|
|
113
|
+
one.
|
|
114
|
+
* Any plug-in like functionality, for example *"check if input is
|
|
115
|
+
correct"*, should go into its own python module inside the `gear/`
|
|
116
|
+
folder. Any variables, functions, and classes related only to that
|
|
117
|
+
implementation should go all inside the same module (Python file).
|
|
118
|
+
* Any general hard definitions, or physical constants, should go in the
|
|
119
|
+
`core/` folder.
|
|
120
|
+
* If you want to implement a new HADDOCK3 module, navigate to the
|
|
121
|
+
`modules/` folder and follow the instructions in the `README` file
|
|
122
|
+
there. You will see that all folders and files follow a pattern.
|
|
123
|
+
* Talk with us before developing any CNS related part.
|
|
124
|
+
|
|
125
|
+
### 1.2 Contributing with tests (additional details)
|
|
126
|
+
|
|
127
|
+
Inside the `tests/` folder you will find several `test_*.py` files.
|
|
128
|
+
Normally, each file has the tests for each `*.py` file in the source. If
|
|
129
|
+
you create new `*.py` files you should create a new test file of the
|
|
130
|
+
same name, `test_new_file_name.py`. Aim at 100% test coverage for the
|
|
131
|
+
code you have created. Write tests according to [pytest][pytest]. You
|
|
132
|
+
can see examples in our `test_*.py` files. You can run the tests using
|
|
133
|
+
the `tox -e test` commands explained above. Or, if you want to run the
|
|
134
|
+
tests for a singly file use `tox -e test -- tests/test_myfile.py`.
|
|
135
|
+
|
|
136
|
+
### 1.3 Dependencies
|
|
137
|
+
|
|
138
|
+
HADDOCK3 is highly interconnected with other projects. Many of them use
|
|
139
|
+
HADDOCK3 core functionalities. Therefore, we aim to keep HADDOCK3 with
|
|
140
|
+
the lowest dependency footprint possible. Avoid adding dependencies when
|
|
141
|
+
developing new functionalities. How?
|
|
142
|
+
|
|
143
|
+
1. Use the Python standard library as much as possible.
|
|
144
|
+
1. Numpy is always allowed.
|
|
145
|
+
1. If you need to implement heavy calculations, it is best you use
|
|
146
|
+
[Numba][numba] instead of C libraries. Talk with us before.
|
|
147
|
+
1. You need a small function from a large library. Try to reimplement it
|
|
148
|
+
yourself with the Python standard library.
|
|
149
|
+
1. If you can't, talk first with
|
|
150
|
+
us by opening an issue.
|
|
151
|
+
1. You need a big and complex function or maybe a whole python file from
|
|
152
|
+
another project. If licenses are compatible, copy their code to the
|
|
153
|
+
HADDOCK3 repository writing all necessary headers to grant authorship
|
|
154
|
+
and comply with license requirements.
|
|
155
|
+
1. If licenses aren't compatible, talk is us. We may have an
|
|
156
|
+
alternative.
|
|
157
|
+
1. Your new module largely depends on a library and reimplementing or
|
|
158
|
+
copying is not an option. Then, consider if we can use that dependency
|
|
159
|
+
as a **runtime dependency** (like `gdock` or `lightdock`) instead of an
|
|
160
|
+
installation dependency.
|
|
161
|
+
1. Nothing of the above is possible. You **really** need an *install
|
|
162
|
+
dependency*. Talk with us before.
|
|
163
|
+
|
|
164
|
+
### 1.4 Code style
|
|
165
|
+
|
|
166
|
+
HADDOCK3 follows nice code style rules. These are *almost* hard rules,
|
|
167
|
+
but there is some room for exceptions - common sense prevails. When
|
|
168
|
+
developing code, run `tox -e lint` to inspect if your code follows our
|
|
169
|
+
conventions. We use [flake8][flake] with the [following rules][fr] and
|
|
170
|
+
docstrings follow [numpydoc][numpydoc] style. You can hold on our code
|
|
171
|
+
for style. Nevertheless, here's a dummy code snippet for your reference.
|
|
172
|
+
Line have a soft max of 80 chars.
|
|
173
|
+
|
|
174
|
+
```python
|
|
175
|
+
"""Module's docstring."""
|
|
176
|
+
# any comments. You can add here licensing stuff
|
|
177
|
+
# first import standard library
|
|
178
|
+
import os
|
|
179
|
+
from path import Pathlib
|
|
180
|
+
|
|
181
|
+
# import third library
|
|
182
|
+
import numpy as np
|
|
183
|
+
|
|
184
|
+
# import from haddock3
|
|
185
|
+
from haddock import log
|
|
186
|
+
# multiline import
|
|
187
|
+
from haddock.libs.libio import (
|
|
188
|
+
lib1,
|
|
189
|
+
lib2,
|
|
190
|
+
lib3,
|
|
191
|
+
lib4,
|
|
192
|
+
)
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
# all this are possible
|
|
196
|
+
GLOBAL_VARIBLE = None
|
|
197
|
+
_hidden_global_variable = None
|
|
198
|
+
|
|
199
|
+
avoid_lower_case_globals = None
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
def my_nice_func(arg1, arg2, arg3):
|
|
203
|
+
"""Docstring here."""
|
|
204
|
+
# do stuf
|
|
205
|
+
|
|
206
|
+
# if the function has many arguments, separate them by new lines.
|
|
207
|
+
# mind the identations
|
|
208
|
+
def my_nice_func_with_big_name(
|
|
209
|
+
var1,
|
|
210
|
+
var2,
|
|
211
|
+
var3,
|
|
212
|
+
named_var1="something",
|
|
213
|
+
named_var2="else",
|
|
214
|
+
**kwargs,
|
|
215
|
+
):
|
|
216
|
+
"""Docstring here."""
|
|
217
|
+
# do stuff
|
|
218
|
+
return
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
multiline_list = [
|
|
222
|
+
var1,
|
|
223
|
+
var2,
|
|
224
|
+
var3,
|
|
225
|
+
var4,
|
|
226
|
+
]
|
|
227
|
+
|
|
228
|
+
multiline_dict = {
|
|
229
|
+
"key1": 1,
|
|
230
|
+
"key2": 2,
|
|
231
|
+
"key3": 3,
|
|
232
|
+
"key4": 4,
|
|
233
|
+
"key5": 5,
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
# separate comprehensions by sections if line don't fit 80 chars
|
|
237
|
+
# same for dictionaries
|
|
238
|
+
cool_list_comprehension = [
|
|
239
|
+
dome_some_long_stuff(i)
|
|
240
|
+
for i in some_iterable
|
|
241
|
+
if validate(i)
|
|
242
|
+
]
|
|
243
|
+
|
|
244
|
+
double_quotes_allowed = "string"
|
|
245
|
+
single_quotes_allowed = 'string'
|
|
246
|
+
# don't try to homogenize quotes all around the code, respect the
|
|
247
|
+
# original input.
|
|
248
|
+
|
|
249
|
+
# define first use later
|
|
250
|
+
generator_with_a_large_name = zip(
|
|
251
|
+
iter1,
|
|
252
|
+
iter2,
|
|
253
|
+
iter3,
|
|
254
|
+
iter4,
|
|
255
|
+
iter5,
|
|
256
|
+
)
|
|
257
|
+
|
|
258
|
+
for a, b, c, d, e in generator_with_a_large_name:
|
|
259
|
+
# do stuff
|
|
260
|
+
|
|
261
|
+
# use noqa: E501 for slightly long lines, in case splitting into
|
|
262
|
+
# multiple lines reduces readability
|
|
263
|
+
this_is_a_long_line = that_makes_no_much_sense(to_separate, in_multiple_lines, abcd) # noqa: E501
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### 1.5 Code structure
|
|
267
|
+
|
|
268
|
+
Write code in the form of small functions, because small functions are
|
|
269
|
+
easier to test. Combine small functions to compose larger functions. If
|
|
270
|
+
you need to use a global variable in a function, pass it as a default
|
|
271
|
+
value of a parameter. Avoid using complex classes, or avoid using
|
|
272
|
+
classes at all, unless you need to maintain a state or you really know
|
|
273
|
+
what you are doing. Flat is better than nested (though it's harder to
|
|
274
|
+
write, but it's easier to maintain and read). Use long variable names if
|
|
275
|
+
needed. Write comments that explain why you do stuff, and not how you do
|
|
276
|
+
stuff. Use the `TODO:` flag in your comments to note something for the
|
|
277
|
+
future. If needed, raise an issue.
|
|
278
|
+
|
|
279
|
+
### 1.6 Creating a new module
|
|
280
|
+
|
|
281
|
+
To develop a new HADDOCK3 module follow our guidelines and templates
|
|
282
|
+
under `src/haddock/modules/_template_cat/_template_mod/`.
|
|
283
|
+
|
|
284
|
+
## 2. Contributing with documentation
|
|
285
|
+
|
|
286
|
+
You may contribute to HADDOCK3 documentation by improving parts where
|
|
287
|
+
documentation is lacking or writing the documentation for the new code
|
|
288
|
+
you propose. HADDOCK3 documentation is hosted online at
|
|
289
|
+
https://bonvinlab.org/haddock3.
|
|
290
|
+
|
|
291
|
+
HADDOCK3 documentation is rendered with
|
|
292
|
+
[Sphinx](https://www.sphinx-doc.org/en/master/) combining markdown
|
|
293
|
+
files, restructured text files, and extracting the docstrings in the
|
|
294
|
+
source code.
|
|
295
|
+
|
|
296
|
+
The `docs/` folder contains all the files used by Sphinx to compile the
|
|
297
|
+
documentation to HTML files. To incorporate new documentation pages or
|
|
298
|
+
update the existing ones, navigate around the `docs/` folder to learn
|
|
299
|
+
how we have structured it and add/edit the files you find relevant. You
|
|
300
|
+
will see that the structure of folders and files follows the design of
|
|
301
|
+
the documentation website.
|
|
302
|
+
|
|
303
|
+
You can render the documentation locally to inspect the end result
|
|
304
|
+
before creating a pull request. To compile the documentation locally:
|
|
305
|
+
activate the `haddock3` python environment inside the haddock3 github
|
|
306
|
+
folder, run `tox -e docs` and then use your favourite browser to open the
|
|
307
|
+
`haddock3-docs/index.html` file. We invite you to read through Sphinx-doc
|
|
308
|
+
webpage if you want to exploit any advanced feature of Sphinx, but we
|
|
309
|
+
already provide examples for virtually any use you may need.
|
|
310
|
+
|
|
311
|
+
If you need to install any additional library, talk to us first. The
|
|
312
|
+
documentation requirements are in the `devtools` folder.
|
|
313
|
+
|
|
314
|
+
Finally, if you find the need to generate new pages during the HTML
|
|
315
|
+
compilation part, you may follow the `devtools/build_defaults_rst.py` as
|
|
316
|
+
an example. See also the `docs/conf.py` file `setup(app)` line.
|
|
317
|
+
|
|
318
|
+
**Troubleshooting:**
|
|
319
|
+
|
|
320
|
+
1. If you add any new dependency (import statement) in the code, you
|
|
321
|
+
need to add that library name to the `mock` list in the `docs/conf.py`
|
|
322
|
+
file.
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
[tox]: https://tox.wiki/en/latest/index.html "tox"
|
|
326
|
+
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
|
|
327
|
+
[pytest]: https://docs.pytest.org/ "pytest"
|
|
328
|
+
[flake]: https://flake8.pycqa.org/en/latest/ "flake8"
|
|
329
|
+
[fr]: https://github.com/haddocking/haddock3/blob/b44304f0a1509d44d9689d7e2e4124f0ae3af0a1/tox.ini#L116-L130
|
|
330
|
+
[numpydoc]: https://numpydoc.readthedocs.io/en/latest/format.html
|
|
331
|
+
[numba]: https://numba.pydata.org/ "Numba"
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# Developing HADDOCK3
|
|
2
|
+
|
|
3
|
+
This file provides information on how to setup a development environment for HADDOCK3.
|
|
4
|
+
|
|
5
|
+
- [System requirements](#system-requirements)
|
|
6
|
+
- [Setting up the development environment](#setting-up-the-development-environment)
|
|
7
|
+
- [Clone the repository](#clone-the-repository)
|
|
8
|
+
- [Python environment](#python-environment)
|
|
9
|
+
- [Install haddock3 in development mode](#install-haddock3-in-development-mode)
|
|
10
|
+
- [Running tests](#running-tests)
|
|
11
|
+
|
|
12
|
+
## System requirements
|
|
13
|
+
|
|
14
|
+
- Python 3.9
|
|
15
|
+
- OpenMPI
|
|
16
|
+
|
|
17
|
+
### Installing system dependencies
|
|
18
|
+
|
|
19
|
+
Below the instructions are provided for a Ubuntu system using `apt-get`. If you are using a different system, please refer to the respective package manager - `yum`, `dnf`, `pacman`, `homebrew`, `port`, etc.
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
sudo apt-get update &&
|
|
23
|
+
# Needed for building Python
|
|
24
|
+
sudo apt-get install build-essential python-setuptools python-pip &&
|
|
25
|
+
sudo apt-get install libncursesw5-dev libgdbm-dev libc6-dev &&
|
|
26
|
+
sudo apt-get install zlib1g-dev libsqlite3-dev tk-dev &&
|
|
27
|
+
sudo apt-get install libssl-dev openssl &&
|
|
28
|
+
sudo apt-get install libffi-dev &&
|
|
29
|
+
# Needed for haddock3 installation
|
|
30
|
+
sudo apt-get install git gcc &&
|
|
31
|
+
# Needed to run the MPI related tests
|
|
32
|
+
sudo apt-get install openmpi-bin libopenmpi3 libopenmpi-dev
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
After all the system-dependencies are in place, download and compile python.
|
|
36
|
+
|
|
37
|
+
**Conda is NOT recommended for development**
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
wget https://www.python.org/ftp/python/3.9.6/Python-3.9.6.tgz
|
|
41
|
+
tar -xf Python-3.9.6.tgz
|
|
42
|
+
cd Python-3.9.6
|
|
43
|
+
./configure --enable-optimizations
|
|
44
|
+
sudo make altinstall -j 8
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Then `python3.9` should be available on your system at `/usr/local/bin/python3.9`
|
|
48
|
+
|
|
49
|
+
On **OSX**, you can use a package-manager such as [brew](https://brew.sh) to install Python 3.9.
|
|
50
|
+
|
|
51
|
+
> Please keep in mind installing python with a package manager can mask system dependencies that your development might add. That's why we recommended you install it from source.
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
brew install python@3.9
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Setting up the development environment
|
|
58
|
+
|
|
59
|
+
### Clone the repository
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
git clone https://github.com/haddocking/haddock3.git
|
|
63
|
+
cd haddock3
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Python environment
|
|
67
|
+
|
|
68
|
+
We recommend you use Python's native virtual environment to manage the dependencies.
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
python3.9 -m venv .venv
|
|
72
|
+
source .venv/bin/activate
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Install haddock3 in development mode
|
|
76
|
+
|
|
77
|
+
Install both project dependencies and test dependencies using pip.
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
pip install -e '.[dev,docs]'
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
> If you are using a Mac, if the installation of mpi4py fails, run first `brew install mpi4py`
|
|
84
|
+
|
|
85
|
+
## Running tests
|
|
86
|
+
|
|
87
|
+
In `haddock3` we use the pytest framework, make sure you check it's [documentation](https://docs.pytest.org/en/6.2.x/contents.html) the tests are located in `tests/` (unit) and `integration_tests/` directories.
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
pytest tests/
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
pytest integration_tests/
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Installation in an HPC environment
|
|
98
|
+
|
|
99
|
+
**Please get in contact with the system administrator before doing development in a shared HPC environment.**
|
|
100
|
+
|
|
101
|
+
For installation in an HPC environment we recommend to check the installed Python versions on the system and also importantly if an `openmpi` (or other custom MPI) installation is available on the system.
|
|
102
|
+
Those are often offered via the `module` command.
|
|
103
|
+
If you only intend to develop haddock3 using the multiprocessing scheduler, the above instructions should be fine. But to harvest the MPI capabilities of an HPC system it is best to build haddock3 using the installed MPI version on the HPC system.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# HADDOCK3 DISCLAIMER
|
|
2
|
+
|
|
3
|
+
The HADDOCK3 software is provided "as is" and without warranties.
|
|
4
|
+
The authors of the software will not be held liable for any use of the HADDOCK3 package and derivatives/results.
|
|
5
|
+
|
|
6
|
+
Some of HADDOCK3 modules use the CNS software (<http://cns-online.org/v1.3/>) (Crystallography and NMR System)
|
|
7
|
+
as computational engine.
|
|
8
|
+
|
|
9
|
+
While CNS is free of use for non-profit users, a proper license is required for commercial applications.
|
|
10
|
+
Biovia is handling those licenses (<https://www.3ds.com/how-to-buy/contact-sales>).
|
|
11
|
+
While they officially do not distribute CNS (CNX) anymore, they usually allow the use of the non-profit version
|
|
12
|
+
provided a proper license is purchased for some of their modelling software.
|
|
13
|
+
|
|
14
|
+
The HADDOCK3 modules using CNS are:
|
|
15
|
+
|
|
16
|
+
- topology modules:
|
|
17
|
+
- topoaa
|
|
18
|
+
- topocg
|
|
19
|
+
|
|
20
|
+
- sampling modules:
|
|
21
|
+
- rigidbody
|
|
22
|
+
|
|
23
|
+
- refinement modules:
|
|
24
|
+
- flexref
|
|
25
|
+
- emref
|
|
26
|
+
- mdref
|
|
27
|
+
|
|
28
|
+
- scoring modules:
|
|
29
|
+
- emscoring
|
|
30
|
+
- mdscoring
|
|
31
|
+
|
|
32
|
+
- analysis modules:
|
|
33
|
+
- alascan
|
|
34
|
+
|
|
35
|
+
Commercial use of any of the above-mentioned modules in a HADDOCK3 workflow will thus require a proper CNS license.
|
|
36
|
+
It is your responsibility as a user to make sure you have such a license.
|
|
37
|
+
|