From 83b080eb4daec2441d66d3582c668305808044df Mon Sep 17 00:00:00 2001 From: Valerij Talagayev <82884038+talagayev@users.noreply.github.com> Date: Fri, 23 Aug 2024 13:39:24 +0200 Subject: [PATCH] Create metadata.yaml Created metadata file for openmmdl --- mdakits/openmmdl/metadata.yaml | 75 ++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 mdakits/openmmdl/metadata.yaml diff --git a/mdakits/openmmdl/metadata.yaml b/mdakits/openmmdl/metadata.yaml new file mode 100644 index 00000000..44ba4164 --- /dev/null +++ b/mdakits/openmmdl/metadata.yaml @@ -0,0 +1,75 @@ +# 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 +#------------------------------------------------------------ +## List(str): a list of commands to use when installing the latest +## release of the code. Note: only one installation method can currently +## be defined. We suggest using mamba where possible (e.g. +## mamba -c conda-forge install MYPROJECT +## for a conda package installation). +## Here we use a simple PyPi installation: +install: + - mamba install -c conda-forge 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: + - pytest openmmdl/ + +## 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