pits3

(Semi)automatic pipeline for TS search in molecular photoswitches

https://github.com/crespilab/pits3

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

(Semi)automatic pipeline for TS search in molecular photoswitches

Basic Info
  • Host: GitHub
  • Owner: CrespiLab
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 1.9 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created 12 months ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

PiTS3

April 23rd, 2025

(Semi)automatic pipeline for transition state (TS) search in molecular photoswitches.

Installation Instructions

Local

python -m venv PiTS3.venv git clone https://github.com/CrespiLab/PiTS3/ source PiTS3.venv/bin/activate (PiTS3.venv) sudo apt install libopenbabel-dev swig (PiTS3.venv) pip install openbabel --global-option=build_ext --global-option="-I/usr/include/openbabel3" \ --global-option="-L/usr/lib/x86_64-linux-gnu/openbabel/3.1.1/" (PiTS3.venv) cd PiTS3 (PiTS3.venv) pip install -e . Adjust according to your folder structure: --global-option="-I/usr/include/openbabel3" and --global-option="-L/usr/lib/x86_64-linux-gnu/openbabel/3.1.1/"

Global environment

Note that xTB and CREST depend on OMPNUMTHREADS global variable, which controls the number of cores available to those utilities. Adjust it accordingly.

By default, the tool will check the accessibility of crest, xtb, orca and pysis in your environment (in PATH). If you have multiple installations/versions of these utilities, make sure the right one is in your PATH or change ts_pipe/config.py accordingly (see instructions in the file). It is especially relevant for working in a supercomputer cluster environment, where you might have a module system for utility loading.

Programmes required

These programmes need to be callable from the command-line (i.e. should be available in your PATH). If not: adjust config.py and add paths to programmes. - OpenBabel - xTB - CREST - ORCA

Cluster

Test run

We provide a set of test examples. These can be run in the test folder using the provided bash script. (PiTS3.venv) /PiTS3/test/test1_cdxml-to-xyz$ ./test1_cdxml-to-xyz.sh (PiTS3.venv) /PiTS3/test/test2_fragments-combiner_tspipe_noorca$ ./test2_fragments-combiner_tspipe_noorca.sh (PiTS3.venv) /PiTS3/test/test3_fragments-combiner_tspipe_orca$ ./test3_fragments-combiner_tspipe_orca.sh

Instructions

Full run (locally)

Example for stilbene, starting from fragments_1.cdxml (1 fragment) and fragments_2.cdxml (2 fragments). The fragment combiner tool yields Cartesian coordinate files of two molecules, named after their molecular formulas: C15H11N.xyz and C15H14O.xyz. fragments_combiner stilbene_fragments_1.cdxml stilbene_fragments_2.cdxml tspipe -m 'C-C=C-C' C15H11N.xyz C15H14O.xyz ts_data_collector -m 'C-C=C-C' C15H11N C15H14O

List of Tools

  • fragments_combiner
  • tspipe
  • tsdatacollector
  • cdxmltoxyz

Fragments Combiner Tool (fragments_combiner)

fragments_combiner frag1.cdxml frag2.cdxml

tspipe

tspipe -m 'C-C=C-C' stilbene.xyz tspipe -m 'C-C=N-C' diarylimine.xyz tspipe -m 'C1=CCNC=C1' ADAE.xyz tspipe -m 'C1C=CCC=C1' NBD.xyz

tsdatacollector

ts_data_collector -m 'C-C=C-C' stilbene ts_data_collector -m 'C-C=N-C' diarylimine ts_data_collector -m 'C1=CCNC=C1' ADAE ts_data_collector -m 'C1C=CCC=C1' NBD

Owner

  • Name: CrespiLab
  • Login: CrespiLab
  • Kind: organization

This organization contains projects of the Crespi Lab.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Peshkov"
  given-names: "Roman Yu."
  orcid: "https://orcid.org/0000-0002-6024-2031"
- family-names: "Steen"
  given-names: "Jorn D."
  orcid: "https://orcid.org/0000-0002-7568-9370"
- family-names: "Crespi"
  given-names: "Stefano"
  orcid: "https://orcid.org/0000-0002-0279-4903"
title: "PiTS3"
version: 1.0.0
identifiers:
  - type: doi
    value: 10.5281/zenodo.15270420
date-released: 2025-04-23
url: "https://github.com/CrespiLab/PiTS3"

GitHub Events

Total
  • Release event: 1
  • Delete event: 1
  • Public event: 1
  • Push event: 11
  • Create event: 3
Last Year
  • Release event: 1
  • Delete event: 1
  • Public event: 1
  • Push event: 11
  • Create event: 3

Dependencies

pyproject.toml pypi
  • numpy ==1.26.4
  • pysisyphus ==0.7.6.post2
  • rdkit ==2024.9.6