Skip to main content

Build coarse-grained molecular systems

Project description

Coarse-grained System Builder (COBY)

The publication is available open-source at https://doi.org/10.1021/acs.jcim.5c00069.

The source code, documentation, and tutorials are avialable on GitHub.

COBY is a Python-based software tool for building flat membranes at a coarse-grained resolution. It supports 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 offers a high degree of customisation. It can be used either as a Python package or directly from the terminal command line. It efficiently manages multiple parameter libraries (even within the same system), making it developer-friendly.

COBY is continuously under development, and we welcome suggestions for new features, which should be submitted under Issues.

Citation (JCIM)

@article{Andreasen2025,
	author = {Andreasen, Mikkel D. and Souza, Paulo C. T. and Schiøtt, Birgit and Zuzic, Lorena},
	title = {Creating Coarse-Grained Systems with COBY: Toward Higher Accuracy of Complex Biological Systems},
	journal = {Journal of Chemical Information and Modeling},
	volume = {0},
	number = {0},
	pages = {null},
	year = {0},
	doi = {10.1021/acs.jcim.5c00069},
	URL = {https://doi.org/10.1021/acs.jcim.5c00069},
	eprint = {https://doi.org/10.1021/acs.jcim.5c00069}
}

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.

OS compatability

COBY has been developed and thoroughly tested on Ubuntu Linux. It has also been tested to a lesser extent on Windows 11 and macOS, with all tutorial systems running without issue.

Testing

Installation can be tested using the tutorial notebooks, which cover the majority of the functions available in COBY.

Basic usage

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

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

Three tutorials are available as Jupyter Notebooks: one covering the basics, another focusing on more advanced functionalities, and the final tutorial showcasing the systems from the manuscript.

Known issues

  • Recursion depth crash on Mac
    • Problem: It has been reported that running COBY with newer versions of Shapely on a Mac may lead to crashes caused by exceeding the recursion depth limit. The reason for why or how this happens is unclear but is likely not something that can be fixed by the COBY developer. The error may be relatod the the macOS version as the problem is known to occur on Sonoma but not on Sequoia.
    • Solution 1: Downgrade Shapely to version 2.0.2, which is the newest version known to be stable on Mac.
    • Solution 2: Update your Mac to Sequoia or an even newer version.

Licence

COBY is preserved under the Apache License 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coby-1.0.11.tar.gz (167.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

coby-1.0.11-py3-none-any.whl (225.9 kB view details)

Uploaded Python 3

File details

Details for the file coby-1.0.11.tar.gz.

File metadata

  • Download URL: coby-1.0.11.tar.gz
  • Upload date:
  • Size: 167.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for coby-1.0.11.tar.gz
Algorithm Hash digest
SHA256 34b6e6e97092540f813e8ffc52bc563abc07311a1e7f26ed39941ad85883d02c
MD5 7d2957bd0a9f298fff96792f2e1397ea
BLAKE2b-256 1f6c46121233a3f912d4d532799da4cffcf4be2e1b583604ab54736a9452fe3b

See more details on using hashes here.

File details

Details for the file coby-1.0.11-py3-none-any.whl.

File metadata

  • Download URL: coby-1.0.11-py3-none-any.whl
  • Upload date:
  • Size: 225.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for coby-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 56a54c6edb927c6d789af29a46c651e66a3ed950d9912da8235838433c194c5c
MD5 777c7fb802c13a2f100561b18fd48c0f
BLAKE2b-256 f2cc342fb378244554497a7426919cd84cbbd667f6a958cb400e717adc8a3412

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page