Skip to main content

NMR Data Processing and Analysis Package

Project description



EchoFox

General Information

Welcome to the EchoFox repository!

EchoFox is a Python package developed by the Hiller group at the University of Basel for processing, analyzing, and plotting biomolecular data. The package provides tools for quickly generating clean, publication-ready figures from NMR data.

In addition to NMR-related functionality, EchoFox also includes scripts and utilities for working with data from other common biophysical techniques, such as chromatography runs, ITC experiments, and DSF melting curves. The goal of the project is to make routine data analysis and plotting faster and simpler within the lab and for anyone else who finds it useful.

Installation

The latest main release of EchoFox can be installed using pip:

pip install echofox

The latest (potentially unstable) version can be installed by cloning the repository and installing it so:

[build instructions]

Short examples

import echofox as ef

# Set up plot
fig, axs = ef.make_plot(
    2, 1, size=(45, 12),
    layout="constrained",
    gridspec_kw={'height_ratios': [1, 5]}
)

# Draw secondary structure 
nk.draw_secondary_structure(
    axs[0], "3agx", range=(1, 1+len(seq)),
    domain_color_map=[
      {"name": "JD", "range": [0, 78], "color": "#d23d3d"},
      {"name": "GF", "range": [79, 158], "color": "#888888"},
      {"name": "CTD1", "range": [159, 246], "color": "#68a7ce"},
      {"name": "CTD2", "range": [247, 323], "color": "#4d4d76"},
      {"name": "DD", "range": [324, 340], "color": "#fcd479"},
  ]
)

# Import peak lists
df_ref = ef.import_assignment("reference.xlsx")
df_comp = ef.import_assignment("compare.xlsx")

# Plot CSPs
axs[1] = ef.plot_csps(
    axs[1], df_ref, df_comp,
    bars_kwargs = {
      "width": 1.05,
      "linewidth": 0.0,
      "edgecolor": "black",
    },
    ylim = (0, 0.15)
)

ef.block_missing_res(axs) # Add grey bars for missing residues

ef.save_plot("my_plot", formats=["png", "pdf"], dpi=300) # Export plot

License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

echofox-0.1.0.tar.gz (74.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

echofox-0.1.0-py3-none-any.whl (88.9 kB view details)

Uploaded Python 3

File details

Details for the file echofox-0.1.0.tar.gz.

File metadata

  • Download URL: echofox-0.1.0.tar.gz
  • Upload date:
  • Size: 74.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for echofox-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0d753f97c0e02db695abeefdb6f7cc559b31200afe2cb3499fd9302e8a05831c
MD5 20289a405f8259226b5e5bf81a3b608d
BLAKE2b-256 3122753042a80b98830abaf387a66c58c04be0a0d9bdbec82809937784f93ec7

See more details on using hashes here.

File details

Details for the file echofox-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: echofox-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 88.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for echofox-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0bf9cb15d781a8ad7f6e16398014b7e4198ec7d2d79a7ec5f2ff86fc35fb2ebe
MD5 888021ff5ad1f98c3e8edf074b50b286
BLAKE2b-256 a6ba77734824bf278292d26e769b44132f86cf909a89706bfd59c35ecae4f071

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page