Skip to content

Hello-QM/catgo-LRG / server/catgo/workflow

catgo-workflow

Verified

Create and manage computational chemistry workflows with CatGo. Supports VASP, CP2K, ORCA, MLP, LAMMPS. Build OER/HER/CO2RR workflows, geometry optimization, frequency analysis, Gibbs energy calculations.

FileKindSize
SKILL.mdskill md3.8 KB
__init__.pyscript1.1 KB
builtins.pyscript4.7 KB
builtins_impl.pyscript21.2 KB
config.pyscript6.5 KB
db.pyscript25.3 KB
engine/__init__.pyscript615 B
engine/advancer.pyscript9.3 KB
engine/ai_diagnosis.pyscript3.8 KB
engine/batch_submitter.pyscript9.7 KB
engine/broadcast.pyscript1.8 KB
engine/collector.pyscript8.3 KB
engine/control_flow.pyscript5.7 KB
engine/engine_builtins.pyscript19.6 KB
engine/engine_registry.pyscript1.5 KB
engine/error_handler.pyscript3.6 KB
engine/hpc_utils.pyscript4.0 KB
engine/job_script.pyscript11.6 KB
engine/lifecycle.pyscript10.8 KB
engine/orca_progress.pyscript3.4 KB
engine/poller.pyscript11.7 KB
engine/resolver.pyscript2.7 KB
engine/result_collector.pyscript56.3 KB
engine/result_handler.pyscript5.6 KB
engine/scanner.pyscript52.0 KB
engine/smart_recovery.pyscript3.6 KB
engine/submitter.pyscript26.2 KB
engine/v1_monitor.pyscript2.7 KB
engine/vasp_submission.pyscript29.0 KB
graph_converter.pyscript6.5 KB
mcp_tools.pyscript7.5 KB
provenance.pyscript5.8 KB
reference.pyscript1.1 KB
service.pyscript4.0 KB
state_map.pyscript1.5 KB
states.pyscript7.5 KB
task_decorator.pyscript2.5 KB
task_ids.pyscript986 B
v1_compat.pyscript2.8 KB
workflow.pyscript12.0 KB

builtins.py

View on GitHub
"""Built-in task type definitions for CatGo.

Import this module to register all standard task types:
    from catgo.workflow.builtins import geo_opt, freq, gibbs_energy

Implementations live in builtins_impl.py to keep this file focused
on @task registrations with minimal bodies.
"""

from catgo.workflow.task_decorator import task
from catgo.workflow.builtins_impl import (
    run_structure_input,
    run_gibbs_energy,
    run_slab_gen,
    run_adsorbate_place,
    run_free_energy_diagram,
    run_dos_analysis,
    run_charge_analysis,
)


# --- Control-Flow ---

@task(task_type="__map__", local=True, outputs=["status"])
def map_controller(**kwargs):
    """Map controller -- never executed directly. Children run instead."""
    return {"status": "mapped"}


@task(task_type="__while__", local=True, outputs=["status", "iterations"])
def while_controller(**kwargs):
    """While loop controller -- manages iteration cycles.

    The scanner handles while-loop logic directly; this function
    is only called if the loop has no children (immediate completion).
    """
    return {"status": "loop_complete", "iterations": 0}


@task(task_type="__zone__", local=True, outputs=["status"])
def zone_controller(**kwargs):
    """Zone controller -- completes when all children complete.

    The scanner handles zone completion logic directly; this function
    is only called if the zone has no children (immediate completion).
    """
    return {"status": "zone_complete"}


# --- Input ---

@task(task_type="structure_input", local=True, outputs=["structure"])
def structure_input(structure=None, **params):
    """Pass-through: provides a structure to the workflow."""
    return run_structure_input(structure, **params)


@task(task_type="structure_list_input", local=True, outputs=["structures"])
def structure_list_input(structures=None, **params):
    return {"structures": structures}


# --- Build ---

@task(task_type="slab_gen", local=True, outputs=["structure"])
def slab_gen(structure=None, miller=(1, 1, 0), layers=4, vacuum=15.0, **params):
    """Generate slab -- delegates to pymatgen SlabGenerator."""
    return run_slab_gen(structure, miller, layers, vacuum, **params)


@task(task_type="adsorbate_place", local=True, outputs=["structure"])
def adsorbate_place(structure=None, species="OH", site="all", height=2.0, **params):
    """Place adsorbate on surface -- returns structure with adsorbate."""
    return run_adsorbate_place(structure, species, site, height, **params)


# --- Calculation (HPC) ---

@task(software="vasp", task_type="geo_opt", outputs=["structure", "energy"])
def geo_opt(structure, ENCUT=520, EDIFF=1e-5, NSW=200, ISIF=2, IBRION=2,
            EDIFFG=-0.02, system_name="", **params):
    pass


@task(software="vasp", task_type="single_point", outputs=["structure", "energy"])
def single_point(structure, ENCUT=520, EDIFF=1e-5, NSW=0, IBRION=-1,
                 system_name="", **params):
    pass


@task(software="vasp", task_type="freq", outputs=["frequencies", "zpe"])
def freq(structure, ENCUT=520, EDIFF=1e-6, IBRION=5, NFREE=2, POTIM=0.015,
         freeze_mode="none", system_name="", **params):
    pass


@task(software="vasp", task_type="cell_opt", outputs=["structure", "energy"])
def cell_opt(structure, ENCUT=520, EDIFF=1e-5, NSW=200, ISIF=3,
             system_name="", **params):
    pass


@task(software="vasp", task_type="md", outputs=["trajectory", "energy"])
def md(structure, ENCUT=520, NSW=1000, IBRION=0, POTIM=1.0,
       TEBEG=300, system_name="", **params):
    pass


# --- Analysis (Local) ---

@task(task_type="gibbs_energy", local=True, outputs=["gibbs", "zpe"])
def gibbs_energy(energy=None, frequencies=None, phase="adsorbed",
                 temperature=298.15, freq_cutoff=50, pressure_atm=1.0,
                 n_unpaired=0, system_name="", **params):
    """Compute Gibbs free energy: G = E_DFT + ZPE - TS."""
    return run_gibbs_energy(
        energy, frequencies, phase, temperature,
        freq_cutoff, pressure_atm, n_unpaired, system_name, **params,
    )


@task(task_type="free_energy_diagram", local=True, outputs=["plotly_data"])
def free_energy_diagram(gibbs_values=None, step_order=None, **params):
    """Generate free energy diagram data."""
    return run_free_energy_diagram(gibbs_values, step_order, **params)


@task(task_type="dos_analysis", local=True, outputs=["dos_data"])
def dos_analysis(data=None, d_band=True, **params):
    """DOS analysis -- requires HPC output data."""
    return run_dos_analysis(data, d_band, **params)


@task(task_type="charge_analysis", local=True, outputs=["charges"])
def charge_analysis(data=None, method="bader", **params):
    """Charge analysis -- requires HPC output data."""
    return run_charge_analysis(data, method, **params)
planning-and-task-breakdownaddyosmani/agent-skillsBreaks work into ordered tasks. Use when you have a spec or clear requirements and need to break work into implementable tasks. Use when a task feels too large to start, when you need to estimate scope, or when parallel work is possible.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
screenpipethedotmack/claude-memSearch screen and audio history recorded by Screenpipe and optionally save selected context into claude-mem. Use when the user asks to recall desktop activity, a meeting, or something seen in another app through Screenpipe.Stars: 118kUpdated Claude CodeCodexVerifiedInstall
contact-widgetnexu-io/open-designSelf-contained floating chat widget with welcome screen, social links, meeting button, and message input. Single HTML file, zero dependencies.Stars: 108kUpdated Claude CodeCodexVerifiedInstall
meeting-notesnexu-io/open-designMeeting notes page — title bar with attendees, agenda checklist, decisions block, action items table with owners + dates, and a "next meeting" footer. Use when the brief mentions "meeting notes", "minutes", "1:1 notes", "all-hands recap", or "会议纪要".Stars: 108kUpdated Claude CodeCodexVerifiedInstall