-
Notifications
You must be signed in to change notification settings - Fork 26
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.
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
Add pore analyser to md kits #172
Open
DSeiferth
wants to merge
8
commits into
MDAnalysis:main
Choose a base branch
from
DSeiferth:add_PoreAnalyser_to_MDKits
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
0e3b5a9
add PoreAnalyser
DSeiferth d1fcd4c
del
DSeiferth 938904c
add metadata
DSeiferth 37c3481
Merge branch 'add_PoreAnalyser_to_MDKits' of https://github.com/DSeif…
orbeckst 5f2cd3d
changes from pull request
DSeiferth 79fad3c
Merge branch 'add_PoreAnalyser_to_MDKits' of https://github.com/DSeif…
DSeiferth 62f866b
change liscene to or later
DSeiferth 5ade7c8
Update mdakits/PoreAnalyser/metadata.yaml
DSeiferth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
project_name: PoreAnalyser | ||
|
||
authors: | ||
- David Seiferth | ||
|
||
maintainers: | ||
- DSeiferth | ||
- philbiggin | ||
|
||
description: | ||
PoreAnalyser is a Python library for analysing (ion channel) pore profiles. We introduce an algorithm that employs | ||
ellipsoidal probe particles, enabling a more comprehensive characterization of pore asymmetries. A constriction is | ||
more asymmetric for a larger difference between the smaller and larger radius of the ellipsoidal probe particle. | ||
Furthermore, we make use of the more accurate characterization of channel pores to refine a physical conductance | ||
model to obtain a heuristic estimate for single-channel conductance. | ||
|
||
keywords: | ||
- channels | ||
- conductance | ||
- pore | ||
|
||
## See https://spdx.org/licenses/ for valid license specifiers | ||
license: LGPL-2.1-or-later | ||
|
||
project_home: https://github.com/DSeiferth/PoreAnalyser | ||
|
||
documentation_home: https://porefinding.readthedocs.io | ||
|
||
## str: the type of documentation available [UserGuide, API, README] | ||
documentation_type: UserGuide + API + README | ||
|
||
## List(str): a list of commands to use when installing the mdakit from its | ||
## source code. | ||
src_install: | ||
- pip install git+https://github.com/DSeiferth/PoreAnalyser@main | ||
|
||
import_name: PoreAnalyser | ||
|
||
python_requires: ">=3.9" | ||
|
||
mdanalysis_requires: ">=2.0.0" | ||
|
||
run_tests: | ||
- git clone latest | ||
- cd PoreAnalyser # tests are in PoreAnalyser/tests/ | ||
- python -m unittest discover | ||
|
||
## 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: | ||
# - mamba install pytest MDAnalysisTests | ||
|
||
## str: the organisation name the MDAKit falls under | ||
project_org: DSeiferth | ||
|
||
#------------------------------------------------------------ | ||
# Optional entries | ||
#------------------------------------------------------------ | ||
install: | ||
- pip install PoreAnalyser | ||
|
||
## str: the development status of the MDAKit | ||
## See https://pypi.org/classifiers/ for development status classifiers. | ||
#development_status: Production/Stable | ||
|
||
publications: | ||
- https://doi.org/10.1016/j.bpj.2024.07.010 | ||
orbeckst marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd add it — there's no shame in labelling it as alpha or beta. Or stable or mature ;-)