-
Notifications
You must be signed in to change notification settings - Fork 26
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 openmmdl as MDAKit #161
Merged
Merged
Changes from 29 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
83b080e
Create metadata.yaml
talagayev 75cfc1c
Update metadata.yaml
talagayev 62c0bdc
Update metadata.yaml
talagayev ae3a7d1
Update metadata.yaml
talagayev 0256672
Update metadata.yaml
talagayev 08899dc
Update metadata.yaml
talagayev 82e7c1f
Update metadata.yaml
talagayev 9440007
Update metadata.yaml
talagayev 20476de
Update metadata.yaml
talagayev 9216278
Update metadata.yaml
talagayev c544863
Update metadata.yaml
talagayev 605281d
Update metadata.yaml
talagayev f966eaa
Update metadata.yaml
talagayev e8d07c8
Update metadata.yaml
talagayev 6b19417
Update metadata.yaml
talagayev b7d20c0
Update metadata.yaml
talagayev 859d1ab
Update metadata.yaml
talagayev ae49e9b
Update metadata.yaml
talagayev bcdf994
Update metadata.yaml
talagayev 1410d2a
Update metadata.yaml
talagayev be7d931
Update metadata.yaml
talagayev 9d42819
Update metadata.yaml
talagayev 8de646d
Update metadata.yaml
talagayev f5d094a
Update metadata.yaml
talagayev a08dc0e
Update metadata.yaml
talagayev 2835e48
Update metadata.yaml
talagayev f51e90e
Update metadata.yaml
talagayev e711476
Update metadata.yaml
talagayev 6a67064
Update metadata.yaml
talagayev 2b1594a
Update metadata.yaml
IAlibay File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
# Required entries | ||
## str: name of the project (the respository name) | ||
project_name: OpenMMDL | ||
|
||
## List(str): a link to the authors file (preferred) or a list of authors | ||
authors: | ||
- https://github.com/wolberlab/OpenMMDL/blob/main/AUTHORS.md | ||
|
||
## List(str): a list of maintainers | ||
## Please note these _must_ be GitHub handles | ||
## The maintainers will be tagged in issues if their MDAKit is failing. | ||
maintainers: | ||
- talagayev | ||
- NDoering99 | ||
- xixichennn | ||
|
||
## str: a free form description of the mdakit | ||
description: | ||
Interface to OpenMM for easy setup of molecular dynamic simulations of protein-ligand complexes and the analysis thereof | ||
|
||
## List(str): a list of keywords which describe the mdakit | ||
keywords: | ||
- MD simulations | ||
- Protein-ligand analysis | ||
- flask-based webserver | ||
- visualization | ||
- openmm | ||
- rdkit | ||
- nglview | ||
|
||
## str: the license the mdakit falls under | ||
## See https://spdx.org/licenses/ for valid license specifiers | ||
license: MIT | ||
|
||
## str: the link to the project's code | ||
## Please note that this is not limited to GitHub! Can be Gitlab, etc.. | ||
project_home: https://github.com/wolberlab/OpenMMDL | ||
|
||
## str: the link to the project's documentation | ||
documentation_home: http://openmmdl.readthedocs.io/ | ||
|
||
## str: the type of documentation available [UserGuide, API, README] | ||
documentation_type: UserGuide + API + README | ||
|
||
#------------------------------------------------------------ | ||
# Optional entries | ||
#------------------------------------------------------------ | ||
|
||
install: | ||
- mamba install -c conda-forge openmmdl | ||
|
||
## List(str): a list of commands to use when installing the mdakit from its | ||
## source code. | ||
src_install: | ||
- | | ||
mamba install -c conda-forge | ||
pip | ||
setuptools>=61.0 | ||
versioningit~=2.0 | ||
pytest>=6.1.2 | ||
pytest-runner | ||
numpy | ||
plip | ||
requests>=2.28.1 | ||
mdtraj | ||
rdkit>=2022.03.5 | ||
pdbfixer | ||
openff-toolkit | ||
openmmforcefields | ||
cudatoolkit>=11.7.0 | ||
cuda-python>=11.7.1 | ||
mdanalysis>=2.3.0 | ||
pytest-shutil>=1.7.0 | ||
flask>=2.2.2 | ||
cairosvg | ||
nglview | ||
numba>=0.59.1 | ||
jupyter | ||
|
||
- pip install git+https://github.com/wolberlab/OpenMMDL | ||
|
||
## str: the package name used to import the mdakit | ||
import_name: openmmdl | ||
|
||
## str: a specification for the range of Python versions supported by this MDAKit | ||
python_requires: ">=3.10" | ||
|
||
## str: a specification for the range of MDAnalysis versions supported by this MDAKit | ||
mdanalysis_requires: ">=2.3.0" | ||
|
||
## List(str): a list of commands to use when attempting to run the MDAKit's tests | ||
run_tests: | ||
- git clone latest | ||
- pytest openmmdl/ | ||
orbeckst marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## str: the development status of the MDAKit | ||
## See https://pypi.org/classifiers/ for development status classifiers. | ||
development_status: "Development Status :: 4 - Beta" | ||
|
||
## str: a link to the MDAKit's changelog | ||
changelog: https://github.com/wolberlab/OpenMMDL/blob/main/CHANGELOG.md |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mdanalysis may not be necessary because I think we install it ourselves — but I doubt it hurts.
Do you have any specific recommendations @IAlibay @fiona-naughton @lilyminium ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also a similar case is for
versioningit
andsetuptools
which I have in thepyproject.toml
so they are installed there in theory, but I thought if I list the remaining packages I can also add them in themamba install
step so that all of the packages necessary for the package are presentThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will keep for now the
mdanalysis>=2.3.0
to see what the others say if it should be removed or retained :)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it makes sense to have MDAnalysis here, in the end this will go in the docs as "this is how you install this".
I have moved pytest things into test_dependencies though, because as far as I'm aware they aren't necessary for the standard operations of the code.