Skip to main content

FIRECODE: Filtering Refiner and Embedder for Conformationally Dense Ensembles

Project description

FIRECODE - Filtering Refiner and Embedder for Conformationally Dense Ensembles

License: GNU LGPL v3 Python Version Powered by: Pixi Size Lines CodeFactor Grade codecov

PyPI Wheel Documentation Status PyPI - Downloads Ruff

Twitter

FIRECODE logo

FIRECODE is a computational chemistry workflow driver for the generation, optimization and refinement of conformational ensembles, also implementing some transition state utilities.

It implements flexible and customizable workflows for conformer generation (via CREST, RDKit), double-ended TS search (NEB via ASE, ML-FSM), and (constrained) ensemble optimization through popular calculators like XTB, TBLITE, ORCA, and Pytorch Neural Network models (AIMNET2, UMA) via ASE.

Conformational pruning is performed with the now standalone PRISM Pruner.

As a legacy feature from TSCoDe, FIRECODE can also assemble non-covalent adducts from conformational ensembles (embedding) programmatically.

Installation

The package is distributed via pip, and the use of uv is highly recommended. The default installation is minimalistic, and torch/GPU support requires dedicated installs:

uv pip install firecode           # XTB, TBLITE, ORCA
uv pip install firecode[aimnet2]  # + AIMNET2
uv pip install firecode[uma]      # + UMA/OMOL
uv pip install firecode[full]     # + AIMNET2, UMA/OMOL

More installation details in the documentation.

Documentation

Additional documentation on how to install and use the program can be found on readthedocs.

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

firecode-1.6.0.tar.gz (14.2 MB view details)

Uploaded Source

Built Distribution

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

firecode-1.6.0-py3-none-any.whl (223.4 kB view details)

Uploaded Python 3

File details

Details for the file firecode-1.6.0.tar.gz.

File metadata

  • Download URL: firecode-1.6.0.tar.gz
  • Upload date:
  • Size: 14.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for firecode-1.6.0.tar.gz
Algorithm Hash digest
SHA256 ec6d696650d6ec176cd50bce10e04b49f3d3f8e8b711ac9749d7f6db002598e1
MD5 ed509003626e9373b22801c8de84f538
BLAKE2b-256 226fa343f6d84d645a49495d1f935cffd94b7743fab52a118c50abc7726c76c3

See more details on using hashes here.

File details

Details for the file firecode-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: firecode-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 223.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for firecode-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b109e3c094aa121f43f8667ec781dec5abc2ed9654c2eb0fb2d34dd2d8cefe9d
MD5 b7b79a5ef47918db2140f92bfdbb04c0
BLAKE2b-256 b0e92ec9bf6455436f2f954cf5f2d7503de25ba11e48869b66db5f97919c30b9

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