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.13.tar.gz (169.1 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.13-py3-none-any.whl (227.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: coby-1.0.13.tar.gz
  • Upload date:
  • Size: 169.1 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.13.tar.gz
Algorithm Hash digest
SHA256 a45184363e45771145884cab17c4d393468bce1de75d3a8c8568c7ebef82a19e
MD5 74a45503b62cc4fff27d134c541a63eb
BLAKE2b-256 43e693dc55e5a6c56cdbf1fa138d867c3a4e8979bbfbeed6100ab29c9bc6d4e5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: coby-1.0.13-py3-none-any.whl
  • Upload date:
  • Size: 227.8 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 376d46f54a2a5187442c51a559e6f68c66b43020b6dbe532160e4d36ce7e0413
MD5 1fe2016b27f73124d26e9b042524608f
BLAKE2b-256 ada52f56acf3d88fc265ad02ef14a5f074e4bf54aad960ec01314f7fef17a337

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