prodigy-prot 2.2.5__tar.gz → 2.3.0__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.
Files changed (41) hide show
  1. prodigy_prot-2.3.0/.github/workflows/ci.yml +49 -0
  2. prodigy_prot-2.3.0/.github/workflows/docker-publish.yml +48 -0
  3. prodigy_prot-2.3.0/.github/workflows/publish.yml +34 -0
  4. prodigy_prot-2.3.0/.gitignore +163 -0
  5. prodigy_prot-2.3.0/.howfairis.yml +9 -0
  6. prodigy_prot-2.3.0/CITATION.cff +47 -0
  7. prodigy_prot-2.3.0/CODE_OF_CONDUCT.md +132 -0
  8. prodigy_prot-2.3.0/CONTRIBUTING.md +17 -0
  9. prodigy_prot-2.3.0/DEVELOPMENT.md +36 -0
  10. prodigy_prot-2.3.0/Dockerfile +8 -0
  11. prodigy_prot-2.3.0/MANIFEST.in +3 -0
  12. {prodigy_prot-2.2.5 → prodigy_prot-2.3.0}/PKG-INFO +79 -50
  13. {prodigy_prot-2.2.5 → prodigy_prot-2.3.0}/README.md +63 -35
  14. prodigy_prot-2.3.0/examples/3BZD.ic_model +13 -0
  15. prodigy_prot-2.3.0/examples/3BZD.pdb +2754 -0
  16. prodigy_prot-2.3.0/examples/3bzd.cif +4727 -0
  17. prodigy_prot-2.3.0/pyproject.toml +45 -0
  18. prodigy_prot-2.3.0/src/prodigy_prot/__init__.py +3 -0
  19. prodigy_prot-2.3.0/src/prodigy_prot/cli.py +127 -0
  20. {prodigy_prot-2.2.5 → prodigy_prot-2.3.0}/src/prodigy_prot/modules/aa_properties.py +3 -12
  21. prodigy_prot-2.3.0/src/prodigy_prot/modules/freesasa_tools.py +65 -0
  22. {prodigy_prot-2.2.5 → prodigy_prot-2.3.0}/src/prodigy_prot/modules/models.py +9 -9
  23. {prodigy_prot-2.2.5 → prodigy_prot-2.3.0}/src/prodigy_prot/modules/parsers.py +63 -64
  24. prodigy_prot-2.2.5/src/prodigy_prot/predict_IC.py → prodigy_prot-2.3.0/src/prodigy_prot/modules/prodigy.py +75 -207
  25. {prodigy_prot-2.2.5 → prodigy_prot-2.3.0}/src/prodigy_prot/modules/utils.py +2 -9
  26. prodigy_prot-2.3.0/tests/__init__.py +3 -0
  27. prodigy_prot-2.3.0/tests/test_data/2oob.cif +3020 -0
  28. prodigy_prot-2.3.0/tests/test_data/2oob.pdb +1449 -0
  29. prodigy_prot-2.3.0/tests/test_data/dataset.json +1460 -0
  30. prodigy_prot-2.3.0/tests/test_data/dataset.tgz +0 -0
  31. prodigy_prot-2.3.0/tests/test_parsers.py +76 -0
  32. prodigy_prot-2.3.0/tests/test_prodigy.py +230 -0
  33. prodigy_prot-2.3.0/tests/test_utils.py +21 -0
  34. prodigy_prot-2.2.5/pyproject.toml +0 -48
  35. prodigy_prot-2.2.5/setup.py +0 -38
  36. prodigy_prot-2.2.5/src/prodigy_prot/modules/__init__.py +0 -10
  37. prodigy_prot-2.2.5/src/prodigy_prot/modules/freesasa_tools.py +0 -240
  38. prodigy_prot-2.2.5/src/prodigy_prot/modules/nis_utils.py +0 -0
  39. {prodigy_prot-2.2.5 → prodigy_prot-2.3.0}/LICENSE +0 -0
  40. {prodigy_prot-2.2.5/src/prodigy_prot → prodigy_prot-2.3.0/src/prodigy_prot/data}/naccess.config +0 -0
  41. {prodigy_prot-2.2.5/src/prodigy_prot → prodigy_prot-2.3.0/src/prodigy_prot/modules}/__init__.py +0 -0
@@ -0,0 +1,49 @@
1
+ name: ci
2
+
3
+ on: push
4
+
5
+ jobs:
6
+ test:
7
+ runs-on: ubuntu-latest
8
+ strategy:
9
+ matrix:
10
+ python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
11
+ fail-fast: false
12
+
13
+ steps:
14
+ - uses: actions/checkout@v4
15
+
16
+ - uses: actions/setup-python@v5
17
+ with:
18
+ python-version: ${{ matrix.python-version }}
19
+
20
+ - run: pip install '.[dev]'
21
+
22
+ - name: check types
23
+ run: mypy .
24
+
25
+ - name: run unittests
26
+ run: >-
27
+ pytest
28
+ -m "not integration"
29
+ --cov
30
+ --cov-report xml:coverage.xml
31
+ --cov-append
32
+ -vv
33
+ --hypothesis-show-statistics
34
+
35
+ - name: run integration tests
36
+ run: >-
37
+ pytest
38
+ -m integration
39
+ --cov
40
+ --cov-report xml:coverage.xml
41
+ --cov-append
42
+ -vv
43
+ --hypothesis-show-statistics
44
+
45
+ - name: Run codacy-coverage-reporter
46
+ uses: codacy/codacy-coverage-reporter-action@v1
47
+ with:
48
+ project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
49
+ coverage-reports: coverage.xml
@@ -0,0 +1,48 @@
1
+ #
2
+ name: Create and publish a Docker image
3
+
4
+ on:
5
+ push:
6
+ # run only against tags
7
+ tags:
8
+ - "*"
9
+
10
+ env:
11
+ REGISTRY: ghcr.io
12
+ IMAGE_NAME: ${{ github.repository }}
13
+
14
+ # There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
15
+ jobs:
16
+ build-and-push-image:
17
+ runs-on: ubuntu-latest
18
+ # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
19
+ permissions:
20
+ contents: read
21
+ packages: write
22
+
23
+ steps:
24
+ - name: Checkout repository
25
+ uses: actions/checkout@v4
26
+
27
+ # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
28
+ - name: Log in to the Container registry
29
+ uses: docker/login-action@v3
30
+ with:
31
+ registry: ${{ env.REGISTRY }}
32
+ username: ${{ github.actor }}
33
+ password: ${{ secrets.GITHUB_TOKEN }}
34
+
35
+ # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
36
+ - name: Extract metadata (tags, labels) for Docker
37
+ id: meta
38
+ uses: docker/metadata-action@v5
39
+ with:
40
+ images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
41
+
42
+ - name: Build and push
43
+ uses: docker/build-push-action@v5
44
+ with:
45
+ context: .
46
+ push: ${{ github.event_name != 'pull_request' }}
47
+ tags: ${{ steps.meta.outputs.tags }}
48
+ labels: ${{ steps.meta.outputs.labels }}
@@ -0,0 +1,34 @@
1
+ name: publish to pypi
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ jobs:
8
+ pypi_release:
9
+ name: builds and publishes to pypi
10
+ runs-on: ubuntu-latest
11
+ environment:
12
+ name: pypi
13
+ url: https://pypi.org/p/prodigy-prot
14
+ permissions:
15
+ id-token: write
16
+
17
+ steps:
18
+ - uses: actions/checkout@v4
19
+
20
+ - uses: actions/setup-python@v5
21
+ with:
22
+ python-version: "3.13"
23
+
24
+ - name: install dependencies
25
+ run: |
26
+ python -m pip install --upgrade pip
27
+ python -m pip install --upgrade build
28
+
29
+ - name: build
30
+ run: |
31
+ python -m build
32
+
33
+ - name: Publish package distributions to PyPI
34
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,163 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ # lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # poetry
98
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
+ #poetry.lock
103
+
104
+ # pdm
105
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
+ #pdm.lock
107
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
+ # in version control.
109
+ # https://pdm.fming.dev/#use-with-ide
110
+ .pdm.toml
111
+
112
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113
+ __pypackages__/
114
+
115
+ # Celery stuff
116
+ celerybeat-schedule
117
+ celerybeat.pid
118
+
119
+ # SageMath parsed files
120
+ *.sage.py
121
+
122
+ # Environments
123
+ .env
124
+ .venv
125
+ env/
126
+ venv/
127
+ ENV/
128
+ env.bak/
129
+ venv.bak/
130
+
131
+ # Spyder project settings
132
+ .spyderproject
133
+ .spyproject
134
+
135
+ # Rope project settings
136
+ .ropeproject
137
+
138
+ # mkdocs documentation
139
+ /site
140
+
141
+ # mypy
142
+ .mypy_cache/
143
+ .dmypy.json
144
+ dmypy.json
145
+
146
+ # Pyre type checker
147
+ .pyre/
148
+
149
+ # pytype static type analyzer
150
+ .pytype/
151
+
152
+ # Cython debug symbols
153
+ cython_debug/
154
+
155
+ # PyCharm
156
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
159
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
160
+ #.idea/
161
+
162
+ .vscode/
163
+ poetry.lock
@@ -0,0 +1,9 @@
1
+ ## Uncomment a line if you want to skip a given category of checks
2
+
3
+ #skip_repository_checks_reason: <reason for skipping goes here>
4
+ #skip_license_checks_reason: <reason for skipping goes here>
5
+ #skip_registry_checks_reason: <reason for skipping goes here>
6
+ #skip_citation_checks_reason: <reason for skipping goes here>
7
+ skip_checklist_checks_reason: "I'm using the Codacy dashboard to guide my development"
8
+
9
+ ignore_commented_badges: false
@@ -0,0 +1,47 @@
1
+ # This CITATION.cff file was generated with cffinit.
2
+ # Visit https://bit.ly/cffinit to generate yours today!
3
+
4
+ cff-version: 1.2.0
5
+ title: Prodigy
6
+ message: >-
7
+ If you use this software, please cite it using the
8
+ metadata from this file.
9
+ type: software
10
+ authors:
11
+ - given-names: Anna
12
+ family-names: Vangone
13
+ affiliation: Utrecht University
14
+ - given-names: Alexandre
15
+ name-particle: MJJ
16
+ family-names: Bonvin
17
+ affiliation: Utrecht University
18
+ - given-names: Joerg
19
+ family-names: Schaarschmidt
20
+ affiliation: Utrecht University
21
+ - given-names: Rodrigo
22
+ family-names: Vargas Honorato
23
+ affiliation: Utrecht University
24
+ - given-names: Brian
25
+ family-names: Jimenez
26
+ affiliation: Utrecht University
27
+ - given-names: Joao
28
+ family-names: Rodrigues
29
+ affiliation: Utrecht University
30
+ identifiers:
31
+ - type: doi
32
+ value: 10.1093/bioinformatics/btw514
33
+ description: DOI of the web service version
34
+ - type: doi
35
+ value: 10.7554/eLife.07454
36
+ - type: doi
37
+ value: 10.1016/j.jmb.2014.04.017
38
+ repository-code: 'https://github.com/haddocking/prodigy'
39
+ url: 'https://wenmr.science.uu.nl/prodigy'
40
+ abstract: >-
41
+ A tool to predict binding affinity values for
42
+ protein-protein complexes from atomic structures.
43
+ keywords:
44
+ - binding affinity
45
+ - computational biology
46
+ - protein-protein
47
+ license: Apache-2.0
@@ -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
+ `prodigy.bonvinlab@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,17 @@
1
+ # Contributing with PRODIGY
2
+
3
+ ## Reporting issues
4
+
5
+ If you find a bug or have a feature request, please report it in the [issue tracker](https://github.com/haddocking/prodigy/issues)
6
+
7
+ ## Contributing code
8
+
9
+ We welcome contributions to PRODIGY. If you would like to contribute, please fork the repository and make a pull request.
10
+
11
+ ## Development conventions
12
+
13
+ Please refer to the [development guidelines](DEVELOPMENT.md) for more details.
14
+
15
+ ## Contact
16
+
17
+ If you have any questions, please contact us at [ask.bioexcel.eu](https://ask.bioexcel.eu)
@@ -0,0 +1,36 @@
1
+ # PRODIGY Development
2
+
3
+ ## Installation
4
+
5
+ We use `poetry` to manage the dependencies and the virtual environment, so you need to install it first; check the [official documentation](https://python-poetry.org/docs/#installation) for more details.
6
+
7
+ Clone the repository and install the dependencies:
8
+
9
+ ```text
10
+ git clone https://github.com/haddocking/prodigy.git && cd prodigy
11
+ poetry install
12
+ ```
13
+
14
+ ## Testing
15
+
16
+ To run the tests, use the following command:
17
+
18
+ ```text
19
+ python -m unittest
20
+ ```
21
+
22
+ ## Code style
23
+
24
+ We use `trunk` as the "all-purpose" linting tool, check its [documentation](https://docs.trunk.io/docs/install).
25
+
26
+ To check for code style issues, run:
27
+
28
+ ```text
29
+ trunk check
30
+ ```
31
+
32
+ To automatically fix the issues, run:
33
+
34
+ ```text
35
+ trunk fmt
36
+ ```
@@ -0,0 +1,8 @@
1
+ #==============================================================================================
2
+ FROM python:3.12
3
+ WORKDIR /opt/software
4
+ COPY . .
5
+ RUN pip install .
6
+ WORKDIR /data
7
+ ENTRYPOINT [ "prodigy" ]
8
+ #==============================================================================================
@@ -0,0 +1,3 @@
1
+ include README.md
2
+ include src/prodigy_prot/data/naccess.config
3
+