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.

Sign up for GitHub

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

Jump to bottom

Add MD-SAPT to MDAKits #47

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add MD-SAPT to MDAKits #47

Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e402a16
Create metadata.yaml
ALescoulie Apr 17, 2023
ac07c21
Update metadata.yaml
orbeckst Sep 18, 2023
4f2f9ed
install mdsapt properly
orbeckst Sep 18, 2023
1a67667
get tests from checked out source
orbeckst Sep 18, 2023
7dd677c
Merge branch 'MDAnalysis:main' into main
ALescoulie Jun 24, 2024
f6f007f
add conda-forge install
ALescoulie Jun 24, 2024
d30ea9d
make src-install into a list
ALescoulie Jun 24, 2024
2001829
fix test dependencies
ALescoulie Jun 24, 2024
a01a628
fix comma typo in test deps install
ALescoulie Jul 2, 2024
840e2a5
Update mdakits/mdsapt/metadata.yaml
orbeckst Jul 2, 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
59 changes: 59 additions & 0 deletions mdakits/mdsapt/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Required entries
## str: name of the project (the respository name)
project_name: MD-SAPT
## List(str): a list of authors (or a link to the authors file)
authors:
- Alia Lescoulie
- Astrid Yu
- Ashley Ringer McDonald
## List(str): a list of maintainers
maintainers:
- Alia Lescoulie
- Ashley Ringer McDonald
## str: a free form description of the mdakit
description:
SAPT calculations on MD data using Psi4
## List(str): a list of keywords which describe the mdakit
keywords:
- SAPT
- protein
- quantum
## str: the license the mdakit falls under
license: GPL-3.0-or-later
## str: the link to the project's code
project_home: https://github.com/calpolyccg/MDSAPT
## str: the link to the project's documentation
documentation_home: https://mdsapt.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 conda/mamba where possible.
install:
- mamba install -c psi4 mdsapt
orbeckst marked this conversation as resolved.
Show resolved Hide resolved
## List(str): a list of commands to use when installing the mdakit from its
## source code.
src_install:
- pip install git+https://github.com/calpolyccg/MDSAPT@master
orbeckst marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

Note that the „develop“ CI installs your source (ie your master branch) and tests against the MDAnalysis develop branch! That’s the configuration to check for the segfault.

## str: the package name used to import the mdakit
import_name: mdsapt
## str: a specification for the range of Python versions supported by this MDAKit
python_requires: ">=3.8"
## 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
run_tests:
- pytest --pyargs mdsapt.tests
## List(str): a list of commands to use to install the necessary dependencies required
## to run the MDAKit's tests
test_dependencies:
project_org: calpolyccg
## str: the development status of the MDAKit
development_status: Mature
## List(str) a list of publications to cite when using the MDAKit
publications:
Copy link
Member

Choose a reason for hiding this comment

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

paper published?

Copy link
Author

Choose a reason for hiding this comment

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

not yet, were working on it

community_home:
Copy link
Member

Choose a reason for hiding this comment

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

Maybe enable GitHub discussions on https://github.com/calpolyccg/MDSAPT ??

Copy link
Author

Choose a reason for hiding this comment

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

I enabled discussions

Copy link
Member

Choose a reason for hiding this comment

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

Can you add an link to discussions?

## str: a link to the MDAKit's changelog
changelog: https://github.com/calpolyccg/MDSAPT/releases
Loading