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.14.tar.gz (169.2 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.14-py3-none-any.whl (227.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: coby-1.0.14.tar.gz
  • Upload date:
  • Size: 169.2 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.14.tar.gz
Algorithm Hash digest
SHA256 04dfe0437fbddfa1d518f71f6d1d368ced7fb095fc56f5a234015fab7aa0dd0c
MD5 4ed6ec6a87e88e1923691f99e3173c80
BLAKE2b-256 e37a5bbfa04c3511fba85d63a31c7b5889e0dbdb9450cfc6eea6a3ee4f8dfba5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: coby-1.0.14-py3-none-any.whl
  • Upload date:
  • Size: 227.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.14-py3-none-any.whl
Algorithm Hash digest
SHA256 8938cfbe95be617ec2e03b9f56bf38ada36ffc0f02593f5d13a2f2c567cc40c6
MD5 a3834276652d7470657c8c7f96c08ee2
BLAKE2b-256 475335d4591dfe832bea8fd181b5c9644b3ba24f24201964ad841a7c38dc59e9

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