Giter VIP home page Giter VIP logo

coby's Introduction

Coarse-grained System Builder (COBY)

The program as well as document and a tutorial is avialable on the GitHub.

COBY is a Python-based software for building flat membranes in coarse-grained resolution. It handles asymmetric membranes, phase-separated systems, multiple bilayers, protein insertion, solvation and flooding with one or multiple solute molecules of choice.

COBY is versatile, fast, easy-to-use and it also allows for high-level of customisation. It can be used either as a Python package or directly from the terminal command line. It neatly handles multiple parameter libraries (even within the same system), making it developer-friendly.

COBY is continuously under development and we welcome suggestions for new features.

Citation

Andreasen et al. (2024) TBD.

Installation

Using pip (requires python>=3.9)

conda create --name COBY python==3.9 ipykernel

conda activate COBY

pip install COBY

python -m ipykernel install --user --name=COBY

Ipykernel allows the user to use COBY environment within the Jupyter notebook.

Basic usage

For a detailed introduction to the software, please consult COBY Documentation.

For a quick reminder of available commands, you can use the Cheat Sheet.

Two tutorials are available as Jupyter Notebooks, one covering the basics and another covering more advanced functionalities.

It includes (amongst other systems):

  • Simple membrane with protein: A simple POPC membrane with a protein in solvent (water + 0.15 M NaCl) which explains the various arguments in COBY
  • Asymmetric membrane: An asymmetric complex membrane (POPC, POPE and CHOL) in solvent with different area per lipid values for each membrane
  • Phase separated Membrane: A phase separated membrane
  • Monolayers: Two monolayers with solvent between them and vacuum over the pbc
  • Nanodisc: A nanodisc with DMPC lipid contained within and with solvent surrounding it
  • Holes: A membrane with multiple manually defined holes
  • Patches: Multiple manually shaped membrane patches
  • Matryoshka membrane: A matryoshka membrane with a protein in the center
  • Stacked membranes: Three vertically stacked membranes
  • Mixed solvent: A symmetric membrane solvated with regular and small water beads in specified ratios
  • Phase separated solvent: A symmetric membrane solvated with two solvent volumes containing different salt concentrations
  • Flooding of imported solutes: A membrane system that has been flooded with imported solute molecules, followed by solvation
  • COBY logo: Our logo

Licence

COBY is preserved under the Apache License 2.0.

coby's People

Contributors

mikkelda avatar lorena-zuzic avatar

Stargazers

 avatar Thibaut avatar Raúl Mera A. avatar  avatar Fabio Lolicato avatar  avatar Matthijs Tadema avatar LHRK avatar Daniel P. Ramirez-Echemendia avatar Luís Borges Araújo avatar

Watchers

Fabio Lolicato avatar Luís Borges Araújo avatar  avatar

coby's Issues

python CGSB.py [with no arguments]

Should display help message from parser object. Instead it throws an error "print_helper function not known".
Simply replaced
L6211: print_helper() by parser.print_help()

Use in PEGylated protein workflow of polyply

Hi @MikkelDA,

I've heard from @KasperBuskPedersen that this tool is an improved successor to insane. I'm one of the core developer of the polyply package used for generating Martini polymer systems. One of the things polyply is quite frequently used for is making PEGylated lipids. So far the tutorial recommends usage of Insane. Updating using this tool could be a good chance to update the tutorial and give your tool more visibility. Unfortunately, my time is very limited but if you'd adopt the insane commands to your package, I'd be open to updating the tutorial swiftly.

Let me know!

Cheers,
Fabian

Less verbose output

Heyo! Perhaps I missed it, but an option to have a more silent/less verbose output would be great. Maybe keep the detailed output details in the log file only?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.