Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add openmmdl as MDAKit #161

Merged
merged 30 commits into from
Sep 21, 2024
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 Aug 23, 2024
75cfc1c
Update metadata.yaml
talagayev Aug 29, 2024
62c0bdc
Update metadata.yaml
talagayev Sep 3, 2024
ae3a7d1
Update metadata.yaml
talagayev Sep 3, 2024
0256672
Update metadata.yaml
talagayev Sep 3, 2024
08899dc
Update metadata.yaml
talagayev Sep 11, 2024
82e7c1f
Update metadata.yaml
talagayev Sep 11, 2024
9440007
Update metadata.yaml
talagayev Sep 11, 2024
20476de
Update metadata.yaml
talagayev Sep 11, 2024
9216278
Update metadata.yaml
talagayev Sep 11, 2024
c544863
Update metadata.yaml
talagayev Sep 11, 2024
605281d
Update metadata.yaml
talagayev Sep 11, 2024
f966eaa
Update metadata.yaml
talagayev Sep 11, 2024
e8d07c8
Update metadata.yaml
talagayev Sep 11, 2024
6b19417
Update metadata.yaml
talagayev Sep 11, 2024
b7d20c0
Update metadata.yaml
talagayev Sep 11, 2024
859d1ab
Update metadata.yaml
talagayev Sep 11, 2024
ae49e9b
Update metadata.yaml
talagayev Sep 11, 2024
bcdf994
Update metadata.yaml
talagayev Sep 11, 2024
1410d2a
Update metadata.yaml
talagayev Sep 11, 2024
be7d931
Update metadata.yaml
talagayev Sep 11, 2024
9d42819
Update metadata.yaml
talagayev Sep 11, 2024
8de646d
Update metadata.yaml
talagayev Sep 11, 2024
f5d094a
Update metadata.yaml
talagayev Sep 11, 2024
a08dc0e
Update metadata.yaml
talagayev Sep 11, 2024
2835e48
Update metadata.yaml
talagayev Sep 11, 2024
f51e90e
Update metadata.yaml
talagayev Sep 11, 2024
e711476
Update metadata.yaml
talagayev Sep 12, 2024
6a67064
Update metadata.yaml
talagayev Sep 12, 2024
2b1594a
Update metadata.yaml
IAlibay Sep 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions mdakits/openmmdl/metadata.yaml
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
Copy link
Member

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 ?

Copy link
Member Author

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 and setuptools which I have in the pyproject.toml so they are installed there in theory, but I thought if I list the remaining packages I can also add them in the mamba install step so that all of the packages necessary for the package are present

Copy link
Member Author

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 :)

Copy link
Member

Choose a reason for hiding this comment

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

ok

Copy link
Member

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.

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
Loading