secstructartist
This package allows to include pretty secondary structure schemes in matplotlib plots.
Table of content
Installation
Prerequisites
- General prerequisites:
- Python 3.8 or higher
- pip
- Third-party python packages:
- matplotlib
- numpy
Installation from PyPI
This is the recommended way to install the package.
-
Create a virtual environment (optional but recommended):
python3 -m venv secstructartist source secstructartist/bin/activate -
Install python module
pip install secstructartist
Installation from GitHub
Here, you will download the repository, and manually build and install the package.
-
Create a virtual environment (optional but recommended):
python3 -m venv secstructartist source secstructartist/bin/activate -
Clone the repository:
git clone https://github.com/bickeld/secstructartist.git cd secstructartist -
Build package and install
make build make install
Usage
In the examples/ directory there is a Jupyter notebook (link)
with plenty of code examples for simple and advanced use cases. Therefore, only
the basics usage will be shown here.
A simple example
The simplest possible use case:
import matplotlib.pyplot as plt
import secstructartist as ssa
secstruct_str = "LLLSSSSSLLLLLHHHHHHHHLLLHHHHHHHHLLLLLLLLLSSSSSSLLLL"
fig, _objs = ssa.draw(secstruct_str)
fig.savefig("example0.png")
Customizing your plots
Plots can be modified by initializing a custom SecStructArtist.
import matplotlib.pyplot as plt
import secstructartist as ssa
secstruct_str = "LLLSSSSSLLLLLHHHHHHHHLLLHHHHHHHHLLLLLLLLLSSSSSSLLLL"
nres = len(secstruct_str)
# Initialize a custom SecStructArtist istance to modify settings
artist = ssa.SecStructArtist()
# Set global settings
artist.height = .7
artist.linewidth = .8
# Set settings of "H" - Helices
artist["H"].fillcolor = (.9, 0., 0.)
artist["H"].shadecolor = (.7, 0., 0.)
artist["H"].ribbon_period = 3.6
artist["H"].ribbon_width = 2.2
# Set settings of "S" - beta-Sheets
artist["S"].arrow_length = 2.7
artist["S"].fillcolor = "#ddcc00"
artist["S"].height = .5
# Set settings of "L" - loop
artist["L"].linecolor = "blue"
artist["L"].linewidth = 1.8
# Generate figure and axis
fig, ax = plt.subplots(figsize=(4,.4), dpi=150)
# Include secondary structure scheme above the plot
artist.draw(secstruct_str, xpos=list(range(3, 3+nres)), ypos=3.5, ax=ax)
ax.set_xlabel("Residue index")
ax.set_ylim([3, 4])
fig.savefig("example1.png")
License
Distributed under the GNU General Public License v3 (GPLv3) License.
Contributing
If you find a bug, please open a bug report. If you have an idea for an improvement or new feature, please open a feature request.
Authors
Metadata
Release files for secstructartist 1.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 | Actions |
|---|---|---|---|---|
| secstructartist-1.1.3.tar.gz | 10.7 kB | Without provenance | Details for secstructartist-1.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| secstructartist-1.1.3-py3-none-any.whl | Python 3 | none | any | Details for secstructartist-1.1.3-py3-none-any.whl |
Total release size: 24.5 kB
Release files / secstructartist-1.1.3.tar.gz
| Download URL | secstructartist-1.1.3.tar.gz |
|---|---|
| Size | 10.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1c3e804818d9c63d2468442610c77c7e96dce689f5960839e9fdfe1a403a045b
|
|
BLAKE2b-256 checksum How to use checksums |
a02dde19a350ecac66755043e40c47196d8bf5e99e27b87bc57e7fdd4d092a7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.13
|
Release files / secstructartist-1.1.3-py3-none-any.whl
| Download URL | secstructartist-1.1.3-py3-none-any.whl |
|---|---|
| Size | 13.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3c719f998b4d140bae8d01f5d88f14c64b42febd73213461e292340258e7686b
|
|
BLAKE2b-256 checksum How to use checksums |
104357360a618eadd3f62f241e72330a03669b2531326e2fb8095b2d76ebf4a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.13
|
Security for secstructartist 1.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.