Skip to content

Repository files navigation

RuleHub

RuleHub is the canonical repository for curated BioNetGen and BNGL model content used across the RuleWorld ecosystem.

It now serves two roles:

  • a human-browsable archive of published, contributed, tutorial, and validation models
  • the machine-readable source of truth for metadata consumed by tools such as BNG Playground

Repository layout

The repository is organized into a few top-level collections:

  • Published/: literature-backed and curated research models
  • Contributed/: contributed model sets, including BNG Playground examples and validation fixtures
  • Tutorials/: tutorial and teaching-oriented BNGL models
  • PyBioNetGen/: PyBioNetGen reference, benchmark, and support model collections

Most model directories contain:

  • one or more .bngl files
  • metadata.yaml
  • README.md

Examples:

  • Published/Faeder2003/
  • Contributed/BNGPlayground_Examples/...
  • Contributed/BNGPlayground_Validation/...
  • Tutorials/General/polymer/
  • Tutorials/NativeTutorials/...

Metadata and manifest

RuleHub now includes a repository-wide metadata and discovery layer:

  • metadata-schema.yaml: schema for per-directory metadata
  • manifest.json: generated manifest describing discoverable model entries
  • scripts/validate-metadata.js: local metadata validator
  • scripts/generate-manifest.js: manifest generator

This metadata is used for:

  • model discovery and indexing
  • gallery visibility and categorization
  • compatibility flags such as bng2_compatible
  • provenance for published, tutorial, test-case, and AI-generated contributed models

BNG Playground integration

BNG Playground no longer keeps its own bundled BNGL corpus as the runtime source of truth.

Instead:

  • RuleHub hosts the model content and metadata
  • BNG Playground resolves models from RuleHub metadata and manifest outputs
  • local playground analysis and migration scripts may use a local RuleHub checkout via RULEHUB_ROOT

That means updates to model metadata, visibility, provenance, and organization should now happen here in RuleHub.

Validation workflow

Before opening a pull request that adds or changes model content, run:

node scripts/validate-metadata.js
node scripts/generate-manifest.js --root . --output manifest.json

The repository also includes CI validation in .github/workflows/validate.yml.

Adding models

For model submission and curation rules, see AddingModels.md.

In general, contributors should:

  1. place models in the appropriate top-level collection
  2. add or update metadata.yaml
  3. add or update README.md
  4. describe multi-file collections with a collection section when applicable
  5. validate metadata and regenerate manifest.json

Notes on migrated content

RuleHub now contains migrated content that previously lived only inside BNG Playground, including:

  • BNG Playground example models
  • validation fixtures
  • tutorial collections
  • runtime-only BNGL models that required explicit preservation

Those migrated entries keep provenance in metadata.yaml, including source-path history where relevant.

Quick links

About

A repository of rule-based models. Could this be the start of something great?

Resources

Stars

2 stars

Watchers

17 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - RuleWorld/RuleHub: A repository of rule-based models. Could this be the start of something great? · GitHub
Skip to content

Repository files navigation

RuleHub

RuleHub is the canonical repository for curated BioNetGen and BNGL model content used across the RuleWorld ecosystem.

It now serves two roles:

  • a human-browsable archive of published, contributed, tutorial, and validation models
  • the machine-readable source of truth for metadata consumed by tools such as BNG Playground

Repository layout

The repository is organized into a few top-level collections:

  • Published/: literature-backed and curated research models
  • Contributed/: contributed model sets, including BNG Playground examples and validation fixtures
  • Tutorials/: tutorial and teaching-oriented BNGL models
  • PyBioNetGen/: PyBioNetGen reference, benchmark, and support model collections

Most model directories contain:

  • one or more .bngl files
  • metadata.yaml
  • README.md

Examples:

  • Published/Faeder2003/
  • Contributed/BNGPlayground_Examples/...
  • Contributed/BNGPlayground_Validation/...
  • Tutorials/General/polymer/
  • Tutorials/NativeTutorials/...

Metadata and manifest

RuleHub now includes a repository-wide metadata and discovery layer:

  • metadata-schema.yaml: schema for per-directory metadata
  • manifest.json: generated manifest describing discoverable model entries
  • scripts/validate-metadata.js: local metadata validator
  • scripts/generate-manifest.js: manifest generator

This metadata is used for:

  • model discovery and indexing
  • gallery visibility and categorization
  • compatibility flags such as bng2_compatible
  • provenance for published, tutorial, test-case, and AI-generated contributed models

BNG Playground integration

BNG Playground no longer keeps its own bundled BNGL corpus as the runtime source of truth.

Instead:

  • RuleHub hosts the model content and metadata
  • BNG Playground resolves models from RuleHub metadata and manifest outputs
  • local playground analysis and migration scripts may use a local RuleHub checkout via RULEHUB_ROOT

That means updates to model metadata, visibility, provenance, and organization should now happen here in RuleHub.

Validation workflow

Before opening a pull request that adds or changes model content, run:

node scripts/validate-metadata.js
node scripts/generate-manifest.js --root . --output manifest.json

The repository also includes CI validation in .github/workflows/validate.yml.

Adding models

For model submission and curation rules, see AddingModels.md.

In general, contributors should:

  1. place models in the appropriate top-level collection
  2. add or update metadata.yaml
  3. add or update README.md
  4. describe multi-file collections with a collection section when applicable
  5. validate metadata and regenerate manifest.json

Notes on migrated content

RuleHub now contains migrated content that previously lived only inside BNG Playground, including:

  • BNG Playground example models
  • validation fixtures
  • tutorial collections
  • runtime-only BNGL models that required explicit preservation

Those migrated entries keep provenance in metadata.yaml, including source-path history where relevant.

Quick links

About

A repository of rule-based models. Could this be the start of something great?

Resources

Stars

2 stars

Watchers

17 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - RuleWorld/RuleHub: A repository of rule-based models. Could this be the start of something great? · GitHub
Skip to content

Repository files navigation

RuleHub

RuleHub is the canonical repository for curated BioNetGen and BNGL model content used across the RuleWorld ecosystem.

It now serves two roles:

  • a human-browsable archive of published, contributed, tutorial, and validation models
  • the machine-readable source of truth for metadata consumed by tools such as BNG Playground

Repository layout

The repository is organized into a few top-level collections:

  • Published/: literature-backed and curated research models
  • Contributed/: contributed model sets, including BNG Playground examples and validation fixtures
  • Tutorials/: tutorial and teaching-oriented BNGL models
  • PyBioNetGen/: PyBioNetGen reference, benchmark, and support model collections

Most model directories contain:

  • one or more .bngl files
  • metadata.yaml
  • README.md

Examples:

  • Published/Faeder2003/
  • Contributed/BNGPlayground_Examples/...
  • Contributed/BNGPlayground_Validation/...
  • Tutorials/General/polymer/
  • Tutorials/NativeTutorials/...

Metadata and manifest

RuleHub now includes a repository-wide metadata and discovery layer:

  • metadata-schema.yaml: schema for per-directory metadata
  • manifest.json: generated manifest describing discoverable model entries
  • scripts/validate-metadata.js: local metadata validator
  • scripts/generate-manifest.js: manifest generator

This metadata is used for:

  • model discovery and indexing
  • gallery visibility and categorization
  • compatibility flags such as bng2_compatible
  • provenance for published, tutorial, test-case, and AI-generated contributed models

BNG Playground integration

BNG Playground no longer keeps its own bundled BNGL corpus as the runtime source of truth.

Instead:

  • RuleHub hosts the model content and metadata
  • BNG Playground resolves models from RuleHub metadata and manifest outputs
  • local playground analysis and migration scripts may use a local RuleHub checkout via RULEHUB_ROOT

That means updates to model metadata, visibility, provenance, and organization should now happen here in RuleHub.

Validation workflow

Before opening a pull request that adds or changes model content, run:

node scripts/validate-metadata.js
node scripts/generate-manifest.js --root . --output manifest.json

The repository also includes CI validation in .github/workflows/validate.yml.

Adding models

For model submission and curation rules, see AddingModels.md.

In general, contributors should:

  1. place models in the appropriate top-level collection
  2. add or update metadata.yaml
  3. add or update README.md
  4. describe multi-file collections with a collection section when applicable
  5. validate metadata and regenerate manifest.json

Notes on migrated content

RuleHub now contains migrated content that previously lived only inside BNG Playground, including:

  • BNG Playground example models
  • validation fixtures
  • tutorial collections
  • runtime-only BNGL models that required explicit preservation

Those migrated entries keep provenance in metadata.yaml, including source-path history where relevant.

Quick links

About

A repository of rule-based models. Could this be the start of something great?

Resources

Stars

2 stars

Watchers

17 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - RuleWorld/RuleHub: A repository of rule-based models. Could this be the start of something great? · GitHub
Skip to content

Repository files navigation

RuleHub

RuleHub is the canonical repository for curated BioNetGen and BNGL model content used across the RuleWorld ecosystem.

It now serves two roles:

  • a human-browsable archive of published, contributed, tutorial, and validation models
  • the machine-readable source of truth for metadata consumed by tools such as BNG Playground

Repository layout

The repository is organized into a few top-level collections:

  • Published/: literature-backed and curated research models
  • Contributed/: contributed model sets, including BNG Playground examples and validation fixtures
  • Tutorials/: tutorial and teaching-oriented BNGL models
  • PyBioNetGen/: PyBioNetGen reference, benchmark, and support model collections

Most model directories contain:

  • one or more .bngl files
  • metadata.yaml
  • README.md

Examples:

  • Published/Faeder2003/
  • Contributed/BNGPlayground_Examples/...
  • Contributed/BNGPlayground_Validation/...
  • Tutorials/General/polymer/
  • Tutorials/NativeTutorials/...

Metadata and manifest

RuleHub now includes a repository-wide metadata and discovery layer:

  • metadata-schema.yaml: schema for per-directory metadata
  • manifest.json: generated manifest describing discoverable model entries
  • scripts/validate-metadata.js: local metadata validator
  • scripts/generate-manifest.js: manifest generator

This metadata is used for:

  • model discovery and indexing
  • gallery visibility and categorization
  • compatibility flags such as bng2_compatible
  • provenance for published, tutorial, test-case, and AI-generated contributed models

BNG Playground integration

BNG Playground no longer keeps its own bundled BNGL corpus as the runtime source of truth.

Instead:

  • RuleHub hosts the model content and metadata
  • BNG Playground resolves models from RuleHub metadata and manifest outputs
  • local playground analysis and migration scripts may use a local RuleHub checkout via RULEHUB_ROOT

That means updates to model metadata, visibility, provenance, and organization should now happen here in RuleHub.

Validation workflow

Before opening a pull request that adds or changes model content, run:

node scripts/validate-metadata.js
node scripts/generate-manifest.js --root . --output manifest.json

The repository also includes CI validation in .github/workflows/validate.yml.

Adding models

For model submission and curation rules, see AddingModels.md.

In general, contributors should:

  1. place models in the appropriate top-level collection
  2. add or update metadata.yaml
  3. add or update README.md
  4. describe multi-file collections with a collection section when applicable
  5. validate metadata and regenerate manifest.json

Notes on migrated content

RuleHub now contains migrated content that previously lived only inside BNG Playground, including:

  • BNG Playground example models
  • validation fixtures
  • tutorial collections
  • runtime-only BNGL models that required explicit preservation

Those migrated entries keep provenance in metadata.yaml, including source-path history where relevant.

Quick links

About

A repository of rule-based models. Could this be the start of something great?

Resources

Stars

2 stars

Watchers

17 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - RuleWorld/RuleHub: A repository of rule-based models. Could this be the start of something great? · GitHub
Skip to content

Repository files navigation

RuleHub

RuleHub is the canonical repository for curated BioNetGen and BNGL model content used across the RuleWorld ecosystem.

It now serves two roles:

  • a human-browsable archive of published, contributed, tutorial, and validation models
  • the machine-readable source of truth for metadata consumed by tools such as BNG Playground

Repository layout

The repository is organized into a few top-level collections:

  • Published/: literature-backed and curated research models
  • Contributed/: contributed model sets, including BNG Playground examples and validation fixtures
  • Tutorials/: tutorial and teaching-oriented BNGL models
  • PyBioNetGen/: PyBioNetGen reference, benchmark, and support model collections

Most model directories contain:

  • one or more .bngl files
  • metadata.yaml
  • README.md

Examples:

  • Published/Faeder2003/
  • Contributed/BNGPlayground_Examples/...
  • Contributed/BNGPlayground_Validation/...
  • Tutorials/General/polymer/
  • Tutorials/NativeTutorials/...

Metadata and manifest

RuleHub now includes a repository-wide metadata and discovery layer:

  • metadata-schema.yaml: schema for per-directory metadata
  • manifest.json: generated manifest describing discoverable model entries
  • scripts/validate-metadata.js: local metadata validator
  • scripts/generate-manifest.js: manifest generator

This metadata is used for:

  • model discovery and indexing
  • gallery visibility and categorization
  • compatibility flags such as bng2_compatible
  • provenance for published, tutorial, test-case, and AI-generated contributed models

BNG Playground integration

BNG Playground no longer keeps its own bundled BNGL corpus as the runtime source of truth.

Instead:

  • RuleHub hosts the model content and metadata
  • BNG Playground resolves models from RuleHub metadata and manifest outputs
  • local playground analysis and migration scripts may use a local RuleHub checkout via RULEHUB_ROOT

That means updates to model metadata, visibility, provenance, and organization should now happen here in RuleHub.

Validation workflow

Before opening a pull request that adds or changes model content, run:

node scripts/validate-metadata.js
node scripts/generate-manifest.js --root . --output manifest.json

The repository also includes CI validation in .github/workflows/validate.yml.

Adding models

For model submission and curation rules, see AddingModels.md.

In general, contributors should:

  1. place models in the appropriate top-level collection
  2. add or update metadata.yaml
  3. add or update README.md
  4. describe multi-file collections with a collection section when applicable
  5. validate metadata and regenerate manifest.json

Notes on migrated content

RuleHub now contains migrated content that previously lived only inside BNG Playground, including:

  • BNG Playground example models
  • validation fixtures
  • tutorial collections
  • runtime-only BNGL models that required explicit preservation

Those migrated entries keep provenance in metadata.yaml, including source-path history where relevant.

Quick links

About

A repository of rule-based models. Could this be the start of something great?

Resources

Stars

2 stars

Watchers

17 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - RuleWorld/RuleHub: A repository of rule-based models. Could this be the start of something great? · GitHub
Skip to content

Repository files navigation

RuleHub

RuleHub is the canonical repository for curated BioNetGen and BNGL model content used across the RuleWorld ecosystem.

It now serves two roles:

  • a human-browsable archive of published, contributed, tutorial, and validation models
  • the machine-readable source of truth for metadata consumed by tools such as BNG Playground

Repository layout

The repository is organized into a few top-level collections:

  • Published/: literature-backed and curated research models
  • Contributed/: contributed model sets, including BNG Playground examples and validation fixtures
  • Tutorials/: tutorial and teaching-oriented BNGL models
  • PyBioNetGen/: PyBioNetGen reference, benchmark, and support model collections

Most model directories contain:

  • one or more .bngl files
  • metadata.yaml
  • README.md

Examples:

  • Published/Faeder2003/
  • Contributed/BNGPlayground_Examples/...
  • Contributed/BNGPlayground_Validation/...
  • Tutorials/General/polymer/
  • Tutorials/NativeTutorials/...

Metadata and manifest

RuleHub now includes a repository-wide metadata and discovery layer:

  • metadata-schema.yaml: schema for per-directory metadata
  • manifest.json: generated manifest describing discoverable model entries
  • scripts/validate-metadata.js: local metadata validator
  • scripts/generate-manifest.js: manifest generator

This metadata is used for:

  • model discovery and indexing
  • gallery visibility and categorization
  • compatibility flags such as bng2_compatible
  • provenance for published, tutorial, test-case, and AI-generated contributed models

BNG Playground integration

BNG Playground no longer keeps its own bundled BNGL corpus as the runtime source of truth.

Instead:

  • RuleHub hosts the model content and metadata
  • BNG Playground resolves models from RuleHub metadata and manifest outputs
  • local playground analysis and migration scripts may use a local RuleHub checkout via RULEHUB_ROOT

That means updates to model metadata, visibility, provenance, and organization should now happen here in RuleHub.

Validation workflow

Before opening a pull request that adds or changes model content, run:

node scripts/validate-metadata.js
node scripts/generate-manifest.js --root . --output manifest.json

The repository also includes CI validation in .github/workflows/validate.yml.

Adding models

For model submission and curation rules, see AddingModels.md.

In general, contributors should:

  1. place models in the appropriate top-level collection
  2. add or update metadata.yaml
  3. add or update README.md
  4. describe multi-file collections with a collection section when applicable
  5. validate metadata and regenerate manifest.json

Notes on migrated content

RuleHub now contains migrated content that previously lived only inside BNG Playground, including:

  • BNG Playground example models
  • validation fixtures
  • tutorial collections
  • runtime-only BNGL models that required explicit preservation

Those migrated entries keep provenance in metadata.yaml, including source-path history where relevant.

Quick links

About

A repository of rule-based models. Could this be the start of something great?

Resources

Stars

2 stars

Watchers

17 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); GitHub - RuleWorld/RuleHub: A repository of rule-based models. Could this be the start of something great? · GitHub
Skip to content

Repository files navigation

RuleHub

RuleHub is the canonical repository for curated BioNetGen and BNGL model content used across the RuleWorld ecosystem.

It now serves two roles:

  • a human-browsable archive of published, contributed, tutorial, and validation models
  • the machine-readable source of truth for metadata consumed by tools such as BNG Playground

Repository layout

The repository is organized into a few top-level collections:

  • Published/: literature-backed and curated research models
  • Contributed/: contributed model sets, including BNG Playground examples and validation fixtures
  • Tutorials/: tutorial and teaching-oriented BNGL models
  • PyBioNetGen/: PyBioNetGen reference, benchmark, and support model collections

Most model directories contain:

  • one or more .bngl files
  • metadata.yaml
  • README.md

Examples:

  • Published/Faeder2003/
  • Contributed/BNGPlayground_Examples/...
  • Contributed/BNGPlayground_Validation/...
  • Tutorials/General/polymer/
  • Tutorials/NativeTutorials/...

Metadata and manifest

RuleHub now includes a repository-wide metadata and discovery layer:

  • metadata-schema.yaml: schema for per-directory metadata
  • manifest.json: generated manifest describing discoverable model entries
  • scripts/validate-metadata.js: local metadata validator
  • scripts/generate-manifest.js: manifest generator

This metadata is used for:

  • model discovery and indexing
  • gallery visibility and categorization
  • compatibility flags such as bng2_compatible
  • provenance for published, tutorial, test-case, and AI-generated contributed models

BNG Playground integration

BNG Playground no longer keeps its own bundled BNGL corpus as the runtime source of truth.

Instead:

  • RuleHub hosts the model content and metadata
  • BNG Playground resolves models from RuleHub metadata and manifest outputs
  • local playground analysis and migration scripts may use a local RuleHub checkout via RULEHUB_ROOT

That means updates to model metadata, visibility, provenance, and organization should now happen here in RuleHub.

Validation workflow

Before opening a pull request that adds or changes model content, run:

node scripts/validate-metadata.js
node scripts/generate-manifest.js --root . --output manifest.json

The repository also includes CI validation in .github/workflows/validate.yml.

Adding models

For model submission and curation rules, see AddingModels.md.

In general, contributors should:

  1. place models in the appropriate top-level collection
  2. add or update metadata.yaml
  3. add or update README.md
  4. describe multi-file collections with a collection section when applicable
  5. validate metadata and regenerate manifest.json

Notes on migrated content

RuleHub now contains migrated content that previously lived only inside BNG Playground, including:

  • BNG Playground example models
  • validation fixtures
  • tutorial collections
  • runtime-only BNGL models that required explicit preservation

Those migrated entries keep provenance in metadata.yaml, including source-path history where relevant.

Quick links

About

A repository of rule-based models. Could this be the start of something great?

Resources

Stars

2 stars

Watchers

17 watching

Forks

Releases

Packages

Contributors

Languages