Skip to content

Commit

Permalink
Add MDANCE to MDAnalysis (#155)
Browse files Browse the repository at this point in the history
* create MDAKit file
* ensure that both latest and develop tests work (need source code for the tests directory, which is not included in pip package)

---------

Co-authored-by: Oliver Beckstein <orbeckst@gmail.com>
  • Loading branch information
lexin-chen and orbeckst authored Aug 2, 2024
1 parent 797a593 commit fc17d9e
Showing 1 changed file with 109 additions and 0 deletions.
109 changes: 109 additions & 0 deletions mdakits/mdance/metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
#------------------------------------------------------------
# Required entries
#------------------------------------------------------------
## str: name of the project (the respository name)
project_name: MDANCE

## List(str): a link to the authors file (preferred) or a list of authors
authors:
- https://github.com/mqcomplab/MDANCE/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:
- lexin-chen

## str: a free form description of the mdakit
description:
flexible n-ary clustering package for Molecular Dynamics trajectories.

## List(str): a list of keywords which describe the mdakit
keywords:
- clustering
- machine-learning
- algorithms
- molecular-dynamics
- protein-refinement

## 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/mqcomplab/MDANCE

## str: the link to the project's documentation
documentation_home: https://mdance.readthedocs.io

## str: the type of documentation available [UserGuide, API, README]
documentation_type: UserGuide + API

#------------------------------------------------------------
# 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:
- pip install mdance

## List(str): a list of commands to use when installing the mdakit from its
## source code.
src_install:
- pip install git+https://github.com/mqcomplab/MDANCE@main

## str: the package name used to import the mdakit
import_name: mdance

## str: a specification for the range of Python versions supported by this MDAKit
python_requires: ">=3.9"

## str: a specification for the range of MDAnalysis versions supported by this MDAKit
mdanalysis_requires: ">=2.0.0"

## List(str): a list of commands to use when attempting to run the MDAKit's tests
## If you package your tests inside your package then you can typically use the
## pytest --pyargs MYPACKAGE
## command as shown below.
## Otherwise you need to include commands to make the tests available.
## For example, if the tests are in the repository at the top level under `./tests`:
## First use `git clone latest` to either clone the top commit for "development code" checks or check out
## the latest tag for "latest release" checks. Then then run pytest:
## - git clone latest
## - pytest -v ./tests
## Feel free to ask for advice on your pull request!
run_tests:
- git clone latest
- pytest ./tests

## List(str): a list of commands to use to install the necessary dependencies required
## to run the MDAKit's tests.
## The default below _might_ be sufficient or you might not even need MDAnalysisTests:
## make sure that it is appropriate for how you run tests.
test_dependencies:
- pip install pytest

## str: the organisation name the MDAKit falls under
project_org: mqcomplab

## str: the development status of the MDAKit
## See https://pypi.org/classifiers/ for development status classifiers.
development_status: Production/Stable

## List(str) a list of publications to cite when using the MDAKit
## Links to scientific publications or stable URLs (typically of the form
## https://doi.org/<DOI> or to a preprint server)
publications:
- https://doi.org/10.1021/acs.jctc.4c00308
- https://doi.org/10.1021/acs.jctc.4c00362 # If user used PRIME

## str: a link to the MDAKit's community (mailing list, github discussions, etc...)
community_home: https://github.com/mqcomplab/MDANCE/discussions

## str: a link to the MDAKit's changelog
#changelog: https://github.com/MYNAME/MYPROJECT/blob/main/CHANGELOG.md

0 comments on commit fc17d9e

Please sign in to comment.