Skip to main content
maintainers:

andrewtarzia

documentation:

https://cgexplore.readthedocs.io/en/latest/

docs/source/_static/logo.png

Overview

cgexplore or cgx is a general toolkit built on stk for constructing, optimising and exploring molecular coarse-grained models.

Installation

cgexplore can be installed with pip:

pip install cgexplore

Then, update directory structure in env_set.py if using example code.

The library implements some analysis that uses Shape 2.1. Follow the instructions to download and installed at Shape

Developer Setup

To develop with cgexplore, you can clone the repo and use just and uv to setup the dev environment:

just setup

Usage

We are moving toward implementing a recipe list, which can be found in the recipe page.

To reproduce data in DOI: `10.1039/D3SC03991A <https://doi.org/10.1039/D3SC03991A>`_: Download the source code from first_paper_example - presubmission release from Releases.I do not guarantee that running the example code on the current version will work. However, with each pull request a test is run as a GitHub Action connected to this repository. This ensures that the results obtained for a subset of the original data set do not change with changes to this library. Additionally, the naming convention has changed and force field xml files should provide the appropriate information for mapping angles to models.

  • The directory cgexplore contains the actual source code for the package.

  • The directory first_paper_example contains the code for 10.1039/D3SC03991A.

    • generate_XX.py generates cage structures for different topology sets

    • env_set.py sets a specific environment for file outputs

    • plot_XX.py produces images and figures, and performs analysis

Important:

Warning: If you have a CUDA-capable GPU and attempt to use CUDA in the first example, you may get NaN errors due to the torsion restriction for angles at 180 degrees, which cause problematic forces. This will be handled in future versions of the code. And logically, I would suggest removing the torsion restriction for those angles. The platform can be handled through this argument in build_building_blocks and build_populations, which I currently set to None, meaning OpenMM will decide for itself.

How To Cite

If you use cgexplore, please cite this paper

https://doi.org/10.26434/chemrxiv-2025-f034c

and reference this URL

https://github.com/andrewtarzia/CGExplore

If you use our minimial model, please cite this paper

Systematic exploration of accessible topologies of cage molecules via minimalistic models

Publications using CGExplore

Acknowledgements

Funded by the European Union - Next Generation EU, Mission 4 Component 1 CUP E13C22002930006.

This work is now developed as part of the Tarzia Research Group at the University of Birmingham.

Metadata

Release files for cgexplore 2026.10.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cgexplore 2026.10.10.1
File Size Uploaded
cgexplore-2026.10.10.1.tar.gz 66.9 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for cgexplore 2026.10.10.1
File Interpreter ABI Platform
cgexplore-2026.10.10.1-py3-none-any.whl Python 3 none any Details

Total release size: 111.0 MB

Release files / cgexplore-2026.10.10.1.tar.gz

Download URL cgexplore-2026.10.10.1.tar.gz
Size 66.9 MB
Tags Source
SHA-256 checksum
How to use checksums
7087d8ac01b9ee07ea8ef15ba1f6fa87abfa38ab2333d2dc977d39a9ebbd68e9
BLAKE2b-256 checksum
How to use checksums
49f6aab3fe8d8c37bdb58857f315e8f3dce745deba7ef8a6b2311d7dba570e9d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / cgexplore-2026.10.10.1-py3-none-any.whl

Download URL cgexplore-2026.10.10.1-py3-none-any.whl
Size 44.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
1d11ef6b26cae6dbb51dc634d8813f3804a073588501c6f8e55e8dc2462c9938
BLAKE2b-256 checksum
How to use checksums
e392fc4779aedc844a56778812382c66c8d0e13173fdbec7361954b4e3f18b96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page