# KnotPull - a simplifier for 3D structures
KnotPull reduces a user provided 3D structure, to simplify it,
while preserving the topology of the chain. It has been successfully
used for knot detection in proteins and chromatine chains.
It can return either a final, simplified structure, or a .pdb formatted
trajectory of consecutive simplifications performed.
## Install
(soon) `pip install knot_pull `
`pip install --index-url https://test.pypi.org/simple/ knot_pull`
If installing with `pip --user` knot_pull_check and knot_pull_show
will be installed in your user base
(`python -c "import site; print(site.USER_BASE)"`), e.g.
`$HOME/.local/bin/knot_pull_check`
## Running
To run on a specific chain of a local pdb file:
```
knot_pull_check -o -k -c A 3ris.pdb
```
To run on a local xyz file (with format id<whitespace>x<whitespace>y<whitespace>z; chains separated by a line with "END"):
```
knot_pull_check -o from_xyz.pdb -k 05.xyz
```
To run on by structure id from RCSB PDB:
```
knot_pull_check -k 4mcb
```
To show coloured trajectory in PyMOL (if installed):
```
knot_pull_shown my_output_file.pdb
```
If PyMOL is nto available in system path it can be specified as the second argument
### Help:
```
usage: knot_pull_check [-h] [-p] [-t] [-f {pdb,xyz,guess}] [-k] [-c CHAIN]
[-o [OUTPUT]] [-s [SAVE]]
[infile]
Simplify the 3D structure while preserving the topology
positional arguments:
infile Structure file which will be used
optional arguments:
-h, --help show this help message and exit
-p, --preserve_resnums
Keep original numbering
-t, --trajectory Write out all steps of the simplification [default is
1]
-f {pdb,xyz,guess}, --format {pdb,xyz,guess}
Input file format: xyz or pdb [default is guess]
-k, --detect_knot Calculate the knot Dowker notation and assign the knot
type
-c CHAIN, --chain CHAIN
Specify which chain you want to simplify.
-o [OUTPUT], --output [OUTPUT]
Specify the output file. Format is guessed based on
extension [default pdb]. Default is stdout
-s [SAVE], --save [SAVE]
Write out a savefile. If any argument is given here -
run from a savefile (knot detection only).
```
### Copyright (c) Aleksandra Jarmolińska
KnotPull reduces a user provided 3D structure, to simplify it,
while preserving the topology of the chain. It has been successfully
used for knot detection in proteins and chromatine chains.
It can return either a final, simplified structure, or a .pdb formatted
trajectory of consecutive simplifications performed.
## Install
(soon) `pip install knot_pull `
`pip install --index-url https://test.pypi.org/simple/ knot_pull`
If installing with `pip --user` knot_pull_check and knot_pull_show
will be installed in your user base
(`python -c "import site; print(site.USER_BASE)"`), e.g.
`$HOME/.local/bin/knot_pull_check`
## Running
To run on a specific chain of a local pdb file:
```
knot_pull_check -o -k -c A 3ris.pdb
```
To run on a local xyz file (with format id<whitespace>x<whitespace>y<whitespace>z; chains separated by a line with "END"):
```
knot_pull_check -o from_xyz.pdb -k 05.xyz
```
To run on by structure id from RCSB PDB:
```
knot_pull_check -k 4mcb
```
To show coloured trajectory in PyMOL (if installed):
```
knot_pull_shown my_output_file.pdb
```
If PyMOL is nto available in system path it can be specified as the second argument
### Help:
```
usage: knot_pull_check [-h] [-p] [-t] [-f {pdb,xyz,guess}] [-k] [-c CHAIN]
[-o [OUTPUT]] [-s [SAVE]]
[infile]
Simplify the 3D structure while preserving the topology
positional arguments:
infile Structure file which will be used
optional arguments:
-h, --help show this help message and exit
-p, --preserve_resnums
Keep original numbering
-t, --trajectory Write out all steps of the simplification [default is
1]
-f {pdb,xyz,guess}, --format {pdb,xyz,guess}
Input file format: xyz or pdb [default is guess]
-k, --detect_knot Calculate the knot Dowker notation and assign the knot
type
-c CHAIN, --chain CHAIN
Specify which chain you want to simplify.
-o [OUTPUT], --output [OUTPUT]
Specify the output file. Format is guessed based on
extension [default pdb]. Default is stdout
-s [SAVE], --save [SAVE]
Write out a savefile. If any argument is given here -
run from a savefile (knot detection only).
```
### Copyright (c) Aleksandra Jarmolińska
1 maintainer
Metadata
1 maintainer
Release files for knot-pull 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| knot_pull-0.1.3.tar.gz | 23.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| knot_pull-0.1.3-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 52.8 kB
Release files / knot_pull-0.1.3.tar.gz
| Download URL | knot_pull-0.1.3.tar.gz |
|---|---|
| Size | 23.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f29a22d373040a7625347d2d59119aaf6f8faf49b289b1bd214e27056afb738
|
|
BLAKE2b-256 checksum How to use checksums |
899b8460716664511373db2e161fe2843c589d958aee047f3f8a781cdf5fe97a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15rc1
|
Release files / knot_pull-0.1.3-py2-none-any.whl
| Download URL | knot_pull-0.1.3-py2-none-any.whl |
|---|---|
| Size | 29.2 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
c49ea0d878393e90213392c41a84a269ec47419e8dd3fde6651512af524fe838
|
|
BLAKE2b-256 checksum How to use checksums |
43ac7f778d69b8500ef5a547295be218d03afe9b1c8d2e2d05cdceae58f5db53
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15rc1
|
Security for knot-pull 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
