Skip to content

Commit

Permalink
Create metadata.yaml
Browse files Browse the repository at this point in the history
Created metadata file for openmmdl
  • Loading branch information
talagayev authored Aug 23, 2024
1 parent a189017 commit 83b080e
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions mdakits/openmmdl/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 83b080e

Please sign in to comment.