diff --git a/openNucleome/README.md b/openNucleome/README.md new file mode 100644 index 0000000..ae9453e --- /dev/null +++ b/openNucleome/README.md @@ -0,0 +1,13 @@ +## openNucleome + +- __init__: Logs the version and imports main class from the whole_nucleus_model + +- whole_nucleus_model.py: Creates the main class for the system, including the context, and controls which interactions are included during the simulation + +- chromosome.py: All the interactions related to chromosome-chromosome + +- speckle.py: All the interactions between speckle-speckle, and speckle-chromosome + +- nucleolus.py: All the interactions between nucleolus-nucleolus, nucleolus-speckle, and nucleolus-chromosome + +- lamina.py: All the interactions between lamina-other particles, and includes the nucleus deformation force when squeezing the model