engg-skills-common
Skill7 starsChanged 6 months agoApache-2.0View on GitHub
Shared Python package used by all engineering skill scripts in this repository (JSON envelope, license-notification helper, dimensionless numbers, fluids/heat-transfer wrappers, VLE/separations/reactor helpers, compositional data, causal DAG, time-series, separator/valve helpers). Use when authoring a new skill or refactoring an existing one that needs shared utilities. Don't use as a user-facing skill — it has no CLI and no engineering output of its own.
In this repository31 other files it gives its agents.
- absorption-stripping-designSkill
- bayesian-hierarchical-process-modelsSkill
- caustic-merox-extractionSkill
- censored-regressionSkill
- compositional-data-analysisSkill
- control-valve-sizing-isa75Skill
- convective-heat-transfer-correlationsSkill
- design-of-experimentsSkill
- dimensionless-numbersSkill
- distillation-shortcut-designSkill
- distributed-lag-modelsSkill
- engineering-skill-creatorSkill
- engineering-statisticsSkill
- equation-of-state-selectionSkill
- heat-exchanger-sizingSkill
- literature-search-engineeringSkill
- material-energy-balancesSkill
- pipe-flow-pressure-dropSkill
- process-causal-inference-dagsSkill
- process-units-conversionSkill
- reactor-sizing-and-kineticsSkill
- relief-valve-sizing-api520Skill
- separator-vessel-sizingSkill
- sour-gas-amine-treatingSkill
- statistical-process-controlSkill
- steam-tables-iapwsSkill
- thermo-process-propertiesSkill
- time-series-process-data-analysisSkill
- two-phase-flowSkill
- uvSkill
- vle-flash-calculationsSkill
The file
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 61
All functions take keyword arguments for clarity in scripts.
- Very specific: line 62
All functions return plain dicts so json.dumps works.
- Very specific: line 69
Read this SKILL.md and any referenced files needed for the task.
- Very specific: line 70
Use scripts from scripts/ when a deterministic calculation or check is available.
- Very specific: line 91
Run .venv/bin/python -m pytest -q or pytest -q from the repository root after changing shared modules.
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
engg-skills-common (Shared Library)
Overview
This is a developer-facing skill describing the shared Python package
engg_skills_common. All engineering-skill scripts import from it. It
contains:
io.py— JSON envelope,write_json, number parsing helpers.notices.py— warning strings, source notices, and thewrite_license_notificationhelper for the first-useLICENSE_NOTIFICATION.txtartifact.dimensionless.py,units.py,stats.py,doe.py,spc.py,balances.py,fluids.py,heat_transfer.py— original pure-Python helpers.property_backends.py— thin wrappers aroundthermo,chemicals,fluids,htwith soft imports and engineering defaults for LPG.vle.py,separations.py,reactor.py,separator.py,valves.py,two_phase.py,convection.py,coda.py,causal.py,timeseries.py,amine.py,merox.py— newer domain modules.
The package is intentionally light: heavy dependencies (pymc, arviz,
statsmodels) are NEVER imported at module load time. They are loaded
lazily inside the scripts that need them.
When to Use
- Authoring a new skill that needs a shared helper.
- Adding a new shared module for a class of calculations.
- Reviewing the standard JSON envelope or notification pattern.
Don't use for
- Running engineering calculations directly — go through a skill script.
- Adding a heavy ML dependency at module load; use the script PEP-723 header instead.
Conventions
- All functions take keyword arguments for clarity in scripts.
- All functions return plain dicts so
json.dumpsworks. - Validation errors raise
ValueError; missing optional libraries raise a clearRuntimeErrorvia_require_library. - Names are descriptive with unit suffixes (e.g.
rho_kg_m3notrho).
Procedure
- Read this SKILL.md and any referenced files needed for the task.
- Use scripts from
scripts/when a deterministic calculation or check is available. - Preserve stated assumptions, warnings, and scope limits in the final answer.
Pitfalls
- Adding a heavy dependency import at the top of a module instead of
using
_require_libraryinside the function. - Returning numpy arrays or pandas Index objects in a result dict — they do not JSON-serialise. Convert to lists / floats first.
- Mutating a caller's input list/dict in place.
- Writing a function that does I/O. The shared library does math and light orchestration; I/O belongs in the script.
Tests
Tests live in tests/. Each module should have a dedicated
test_<module>.py with at least three tests covering: a typical case,
an edge case (zero / empty), and an error case.
Verification
- Run
.venv/bin/python -m pytest -qorpytest -qfrom the repository root after changing shared modules. - Confirm scripts that import
engg_skills_commonresolve it fromskills/engg-skills-common.
References
- See each skill's SKILL.md for the user-facing usage.
skills/engineering-skill-creator/references/script_template.mdfor the canonical CLI shape that consumes this library.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

