Skip to content

Commit 7264469

Browse files
committed
Adding pytim
1 parent 864b8ec commit 7264469

File tree

1 file changed

+105
-0
lines changed

1 file changed

+105
-0
lines changed

mdakits/pytim/metadata.yaml

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
## str: name of the project (the respository name)
2+
project_name: pytim
3+
4+
## List(str): a link to the authors file (preferred) or a list of authors
5+
authors:
6+
- https://github.com/Marcello-Sega/pytim/blob/main/AUTHORS.md
7+
8+
## List(str): a list of maintainers
9+
## Please note these _must_ be GitHub handles
10+
## The maintainers will be tagged in issues if their MDAKit is failing.
11+
maintainers:
12+
- Marcello Sega
13+
14+
## str: a free form description of the mdakit
15+
description:
16+
(Provides several methods for the detection of fluid interfaces and analysis of their properties)
17+
18+
## List(str): a list of keywords which describe the mdakit
19+
keywords:
20+
- Surface analysis
21+
- Intrinsic properties
22+
23+
## str: the license the mdakit falls under
24+
## See https://spdx.org/licenses/ for valid license specifiers
25+
license: GPL-3.0-or-later
26+
27+
## str: the link to the project's code
28+
## Please note that this is not limited to GitHub! Can be Gitlab, etc..
29+
project_home: https://github.com/Marcello-Sega/pytim
30+
31+
## str: the link to the project's documentation
32+
documentation_home: https://marcello-sega.github.io/pytim
33+
34+
## str: the type of documentation available [UserGuide, API, README]
35+
documentation_type: UserGuide + API + README
36+
37+
#------------------------------------------------------------
38+
# Optional entries
39+
#------------------------------------------------------------
40+
## List(str): a list of commands to use when installing the latest
41+
## release of the code. Note: only one installation method can currently
42+
## be defined. We suggest using mamba where possible (e.g.
43+
## mamba -c conda-forge install pytim
44+
## for a conda package installation).
45+
## Here we use a simple PyPi installation:
46+
install:
47+
- pip install pytim
48+
49+
## List(str): a list of commands to use when installing the mdakit from its
50+
## source code.
51+
src_install:
52+
- pip install git+https://github.com/Marcello-Sega/pytim@master
53+
54+
## str: the package name used to import the mdakit
55+
import_name: pytim
56+
57+
## str: a specification for the range of Python versions supported by this MDAKit
58+
python_requires: ">=3.8"
59+
60+
## str: a specification for the range of MDAnalysis versions supported by this MDAKit
61+
mdanalysis_requires: ">=2.0.0"
62+
63+
## List(str): a list of commands to use when attempting to run the MDAKit's tests
64+
## If you package your tests inside your package then you can typically use the
65+
## pytest --pyargs MYPACKAGE
66+
## command as shown below.
67+
## Otherwise you need to include commands to make the tests available.
68+
## For example, if the tests are in the repository at the top level under `./tests`:
69+
## First use `git clone latest` to either clone the top commit for "development code" checks or check out
70+
## the latest tag for "latest release" checks. Then then run pytest:
71+
## - git clone latest
72+
## - pytest -v ./tests
73+
## Feel free to ask for advice on your pull request!
74+
run_tests:
75+
- git clone latest
76+
- pip install "mdtraj" "codecov==2.1.13" "pytest-cov==5.0.0" "cython>=0.24.1" "scipy>=1.6.0" "gsd<=3.2.1" "PyWavelets>=0.5.2" "scikit-image>=0.14.2" "sphinx>=1.4.3" "matplotlib" "dask>=1.1.1"
77+
- pytest pytim/*py pytim/observables/*py pytim/datafiles/*py --doctest-modules
78+
79+
## List(str): a list of commands to use to install the necessary dependencies required
80+
## to run the MDAKit's tests.
81+
## The default below _might_ be sufficient or you might not even need MDAnalysisTests:
82+
## make sure that it is appropriate for how you run tests.
83+
#test_dependencies:
84+
# - pip install mdtraj "pytest==8.1.1" "codecov==2.1.13" "pytest-cov==5.0.0"
85+
86+
## str: the organisation name the MDAKit falls under
87+
project_org: Marcello-Sega
88+
89+
## str: the development status of the MDAKit
90+
## See https://pypi.org/classifiers/ for development status classifiers.
91+
development_status: Production/Stable
92+
93+
## List(str) a list of publications to cite when using the MDAKit
94+
## Links to scientific publications or stable URLs (typically of the form
95+
## https://doi.org/<DOI> or to a preprint server)
96+
publications:
97+
- https://doi.org/10.1002/jcc.25384
98+
- https://onlinelibrary.wiley.com/doi/epdf/10.1002/jcc.25384
99+
100+
## str: a link to the MDAKit's community (mailing list, github discussions, etc...)
101+
#community_home: URL
102+
103+
## str: a link to the MDAKit's changelog
104+
#changelog: https://github.com/Marcello-Sega/pytim/blob/main/CHANGELOG.md
105+

0 commit comments

Comments
 (0)