rcbs.py

RCBS.py (Reactivity of Chemical and Biochemical Systems) is a Python package that contains several scripts, functions and classes that simplify the analysis of chemical and biochemical simulations.

https://github.com/molbiomeduab/rcbs.py

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary

Keywords

chemistry computational-chemistry molecular-dynamics molecular-dynamics-simulation molecular-modeling molecular-simulation python qm-mm qmmm
Last synced: 6 months ago · JSON representation ·

Repository

RCBS.py (Reactivity of Chemical and Biochemical Systems) is a Python package that contains several scripts, functions and classes that simplify the analysis of chemical and biochemical simulations.

Basic Info
  • Host: GitHub
  • Owner: MolBioMedUAB
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 9.33 MB
Statistics
  • Stars: 3
  • Watchers: 0
  • Forks: 0
  • Open Issues: 6
  • Releases: 10
Topics
chemistry computational-chemistry molecular-dynamics molecular-dynamics-simulation molecular-modeling molecular-simulation python qm-mm qmmm
Created almost 6 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

RCBS.py

DOI GitHub release (latest by date) PyPI GitHub MDAnalysis

Description

RCBS.py (Reactivity of Chemical and Biochemical Systems) is a Python package that contains several scripts, functions and classes that simplify the analysis of chemical and biochemical simulations. It is built on top of MDAnalysis package.

The package currently is divided in one main module, md_analyser. This module is mainly built in top of MDAnalysis' and is designed in order to symplify the analysis of MD simulations. In the future, capabilities for building QM/MM models from simulations will be added in a new module.

Installation

Using pip

bash pip install RCBS.py

From source code

  1. Clone the repository in you local machine bash git clone https://github.com/dynamicsUAB/RCBS.py.git
  2. Move to the folder bash cd RCBS.py
  3. Install the package using pip or pip3 bash pip install .

Usage

md_analyser

md_analyser is made of two principal scripts: measurements.py and calculators.py.

measurements.py

This is the main file that has to be imported. In it a class called Measurement is created. This class has one only argument: a preloaded MDAnalysis' Universe. Once the object is created, measurements such as distances or angles can be created using the add_* functions from the class. They require previous creation of atom groups using the select_atoms function form Universe or the selections.selection function from RCBS.py. The syntax for the addition of a measurement is the following (shown using a distance as an example):

```python from RCBS.md_analyser import measurements

m = measurements.Measurement(u) m.add_distance('name', sel1, sel2) ```

More examples are available in the example Notebook from RCBS.py-examples.

Once all measurements are added, m.run_measure() has to be used in order to run the measurements. The code works in such a way that each frame is loaded, each of the measurements is calculated and the next frame is loaded. A progress bar is shown during the process.

Once the measures are ran, m.run_boolean() can be used to do simple statistical studies. Examples can be found in the example Notebook.

calculators.py

In this file all the calculators are stored (work is being done to move all the calculators from measurements.py). Calculators can do very different things --in fact, anything you can think and code-- from the given selections. Calculators have to be implemented so they do the measure over only one structure (or frame) and they return a single variable.

calculators.py is loaded from measurements.py. Each calculator has to be incorporated in measurements.py, both as a add_* function and in the run_measurement function.

Future additions

  • Create a script for automatically add new calculators to measurements.py.
  • Add more calculators.
  • Create the qmmm module.

Owner

  • Name: MolBioMedUAB
  • Login: MolBioMedUAB
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Canyelles-Niño"
  given-names: "Miquel"
  orcid: "https://orcid.org/0000-0002-8221-2781"
title: "RCBS.py: Reactivity of Chemical and Biochemical Systems"
version: 2.0.4
doi: 10.5281/zenodo.7626048
date-released: 2022-12-20
url: "https://github.com/MolBioMedUAB/RCBS.py"

GitHub Events

Total
Last Year

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 129
  • Total Committers: 2
  • Avg Commits per committer: 64.5
  • Development Distribution Score (DDS): 0.178
Past Year
  • Commits: 67
  • Committers: 2
  • Avg Commits per committer: 33.5
  • Development Distribution Score (DDS): 0.254
Top Committers
Name Email Commits
Miquel Canyelles m****n@g****m 106
mikicanyelles m****o@g****m 23

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 13
  • Total pull requests: 2
  • Average time to close issues: 28 days
  • Average time to close pull requests: 3 minutes
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.62
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mikicanyelles (10)
  • alexpsnchz (1)
Pull Request Authors
  • mikicanyelles (2)
Top Labels
Issue Labels
enhancement (9) bug (1)
Pull Request Labels

Dependencies

requirements.txt pypi
  • MDAnalysis *
  • numpy *
  • pyyaml *
setup.py pypi
  • numpy *