neqsim-your-skill-name

Provides a reusable template for authoring NeqSim community skills with SKILL.md frontmatter and validation checklists.

4|2|Updated May 31, 2026
One-click install
npx skills add https://github.com/equinor/neqsim-community-skills --skill neqsim-your-skill-name-equinor
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: neqsim-your-skill-name
Source: https://github.com/equinor/neqsim-community-skills/tree/main/templates/skill-template
Command: npx skills add https://github.com/equinor/neqsim-community-skills --skill neqsim-your-skill-name-equinor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Contributors to the NeqSim Community Skills repository need a consistent starting structure for new public skills, including correct YAML frontmatter, documentation sections, packaging, and testing conventions. ## Core Features & Use Cases - Standardized Skill Skeleton: Ships a ready-to-copy SKILL.md with required name and description frontmatter plus sections for inputs, outputs, engineering method, and limitations. - Packaging and Test Scaffolding: Includes a pyproject.toml configured for setuptools, pytest testpaths, and optional NeqSim dependencies. - Use Case: A researcher wants to publish a new public NeqSim workflow skill; they copy this template folder, rename it in kebab-case, fill in the placeholders, and add examples and tests before submitting. ## Quick Start Copy the templates/skill-template folder, rename it to your kebab-case skill name, and replace every placeholder in SKILL.md with your skill's real content.

Frequently Asked Questions about neqsim-your-skill-name

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a new NeqSim community skill?▼

Copy the templates/skill-template folder, rename it using kebab-case, and set a name starting with neqsim- in SKILL.md. Then replace all placeholder text, add examples under examples, and write pytest tests under tests.

What frontmatter fields does a SKILL.md file require?▼

A SKILL.md file requires at minimum a name and description in its YAML frontmatter for discovery. The template also includes version, last_verified, and a requires block for Python packages, Java packages, environment, and network needs.

Can I include proprietary data in a NeqSim community skill?▼

No, the repository is for public knowledge only. Confidential data, company-specific methods, private URLs, unpublished correlations, and production design rules must go into private enterprise skill repositories instead.

How are NeqSim skills installed and discovered?▼

Skills are discovered through the NeqSim CLI using neqsim skill list and installed with neqsim skill install. Skills shipping a Python package are installed editable based on their pyproject.toml.

What tests should a new community skill include?▼

The template expects pytest tests under the tests directory covering normal and invalid input cases. The validation checklist also requires public-only example data and explicit limitations.