-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e8f4d71
commit 50cfb2e
Showing
1 changed file
with
12 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,31 @@ | ||
## openNucleome | ||
## OpenNucleome | ||
|
||
OpenNucleome is an open-source software designed for conducting molecular dynamics (MD) simulations of the human nucleus. This software streamlines the process of setting up whole nucleus simulations through just a few lines of Python scripting. OpenNucleome can unveil intricate, high-resolution structural and dynamic chromosome arrangements at a 100 KB resolution. It empowers researchers to track the kinetics of condensate formation and fusion while also exploring the influence of chemical modifications on condensate stability. Furthermore, it facilitates the examination of nuclear envelope deformation's impact on genome organization. The software's modular architecture enhances its adaptability and extensibility. Leveraging the power of OpenMM, a GPU-accelerated MD engine, OpenNucleome ensures efficient simulations. | ||
|
||
## Manual | ||
|
||
The output html manual file is docs/index.html. | ||
<img src="./images/Figure1.png" width="500px"><img> | ||
|
||
The manual is also shown in: https://zhanggroup-mitchemistry.github.io/OpenNucleome/ | ||
## Examples | ||
|
||
Instructions for class methods and functions are also included as comments in the source code. | ||
Details on setting up simulations of a human nucleus can be found at: examples/HFF_100KB. Scripts for analyzing simulation trajectories to compute contact probability maps are provided in: analysis. | ||
|
||
## Environment | ||
|
||
We recommend using openmm 7.5.1 for using openNucleome, as openNucleome is built based on openmm 7.5.1. | ||
|
||
Install openmm 7.5.1 with the following command: | ||
We recommend openmm 7.5.1 when using openNucleome, which can be installed with the following command: | ||
|
||
``` | ||
conda install -c conda-forge openmm=7.5.1 | ||
``` | ||
|
||
Other required packages: numpy, mdanalysis, mdtraj. | ||
|
||
## Manual | ||
|
||
## Workflow for creating the whole nucleus model and efficiency across different platforms | ||
Detailed documentations are included in the source code and can be viewed at: https://zhanggroup-mitchemistry.github.io/OpenNucleome | ||
|
||
<img src="./images/Figure1.png" width="2000px"><img> | ||
## Citations | ||
|
||
Please cite the following paper if you use openabc package: | ||
|
||
"OpenNucleome for high resolution nuclear structural and dynamical modeling", doi: XXX | ||
|
||
## Examples | ||
|
||
We provide an example in examples/HFF_100KB, and we also show how to calculate the contact probabilities and compare with experiments to obtain optimized potential parameters in ./analysis_code. |