Skip to content

ResiDEM, tool to analyze isomorphous difference density map obtained from time resolved crystallography

License

Notifications You must be signed in to change notification settings

TamaLab/residem

Repository files navigation

MIT License Python 3.10 CI

Platform CI Status
OSX macOS Build Status
Linux Ubuntu Build Status

Table of Contents

  1. About
  2. Installation
  3. License
  4. Contact

Resi-DEM.

Resi-DEM is a tool that identifies residues in isomorphous difference density map captured using Time-resolved serial femtosecond crystallographic data. It uses DBSCAN based clustering algorithm to cluster the co-ordinates of the difference peak in the difference density map and assigns the cluster to the neighbouring atoms. It can also perform various calculations and plot their outputs. A breif documentation of ResiDEM can be found here.

Installation

Quick installation of ResiDEM can be done using the following:

  1. Creating a conda virtual environemt:
# you can change the name if you want
conda create -n residem python=3.10
  1. Activation of conda environment
conda activate residem
  1. Updating the environment. Environment file can be found here.
# After activation of residem environment, we can check the location with the command `which python`
# do the following to install in particular residem environemnt

full_path=$(which python)
base_path=$(dirname $(dirname "$full_path"))
echo $base_path

conda env update --prefix $base_path --file environment.yml --prune
  1. To uninstall the package :
pip uninstall residem

License

Residem is an open-source tool available under the MIT License, providing users with the freedom to use, modify, and distribute the software. Additionally, Residem incorporates adapted modules from the Computational Crystallography Toolbox (cctbx), and users are advised to also refer to the cctbx license to comply with its terms and conditions.

Contact

About

ResiDEM, tool to analyze isomorphous difference density map obtained from time resolved crystallography

Resources

License

Stars

Watchers

Forks

Packages

No packages published