@unitpad/modules 0.0.0-stage → 0.1.0

package/modules/units/systems/compute.nbt

@@ -0,0 +1,21 @@
+# Shared units for compute. In every session (via `units::systems`), not importable.
+# title: Shared units (compute)
+# description: The floating-point operation and the vCPU
+
+# One floating-point operation, for compute budgets (`2 TFLOP/s`, `1 teraflop`).
+# No `flops` alias: FLOPS usually means FLOP per second, so write `FLOP/s`.
+dimension FloatingPointOperation
+
+@name("Floating-point operation")
+@url("https://en.wikipedia.org/wiki/FLOPS")
+@metric_prefixes
+@aliases(FLOP: short, flop)
+unit FLOP: FloatingPointOperation
+
+# A vCPU is a separate count dimension so per-vCPU prices can be scaled by a
+# typed vCPU count instead of an untyped scalar.
+dimension Vcpu
+
+@name("vCPU")
+@aliases(vcpus)
+unit vcpu: Vcpu

package/modules/units/systems/network.nbt

@@ -0,0 +1,11 @@
+# Shared units for the network. In every session (via `units::systems`), not importable.
+# title: Shared units (network)
+# description: The packet
+
+# One packet on the network; instance and NIC limits are quoted in packets/s
+dimension Packet
+
+@name("Packet")
+@url("https://en.wikipedia.org/wiki/Network_packet")
+@aliases(pkt, pkts, packets)
+unit packet: Packet

package/modules/units/systems/storage.nbt

@@ -0,0 +1,21 @@
+# Shared units for disk and volume I/O. In every session (via `units::systems`), not importable.
+# title: Shared units (storage)
+# description: The I/O operation and IOPS
+
+# One read or write a disk or volume serves. Its own dimension, not `operation`:
+# Numbat shows a value in the one unit defined as exactly its unit, so if `IOPS`
+# were `operation/s`, every operation rate (Redis, SQL) would print as IOPS.
+# Relate the two with an explicit ratio (`io_per_op = 2 io/operation`).
+dimension IoOperation
+
+@name("I/O operation")
+@url("https://en.wikipedia.org/wiki/IOPS")
+@aliases(ios)
+unit io: IoOperation
+
+# I/O operations per second, as disks and volumes are rated (`500 kIOPS`)
+@name("I/O operations per second")
+@url("https://en.wikipedia.org/wiki/IOPS")
+@metric_prefixes
+@aliases(IOPS: short, iops)
+unit IOPS: IoOperation / Time = io / second

package/modules/units/systems/workload.nbt

@@ -0,0 +1,51 @@
+# Shared count units for the workload a system is given: what it receives, handles and keeps. In every session (via `units::systems`), not importable.
+# title: Shared units (workload)
+# description: Count units for events, operations, requests, messages, rows and records
+
+# Count units. Each is its own base dimension, so rates in different entities do
+# NOT mix: `message/s` and `record/s` are different dimensions, and converting
+# between them needs an explicit ratio (e.g. `records_per_message = 10 record/message`).
+# Rates are written `<unit>/s` — `50_000 operation/s`, `500 message/s`.
+# Laid out like Numbat's own `units::placeholder`: a named dimension, then its unit.
+
+# Something that happened, as logged or emitted
+dimension Event
+
+@name("Event")
+@aliases(evt, events)
+unit event: Event
+
+# One call against a backend: a cache get, a query, a queue send
+dimension Operation
+
+@name("Operation")
+@aliases(op, ops, operations)
+unit operation: Operation
+
+# One call a client makes to a service
+dimension Request
+
+@name("Request")
+@aliases(req, reqs, requests)
+unit request: Request
+
+# One message on a queue or stream
+dimension Message
+
+@name("Message")
+@aliases(msg, msgs, messages)
+unit message: Message
+
+# One row in a table
+dimension Row
+
+@name("Row")
+@aliases(rows)
+unit row: Row
+
+# One record in a log, a file or a stream
+dimension Record
+
+@name("Record")
+@aliases(rec, recs, records)
+unit record: Record

package/modules/units/systems.nbt

@@ -0,0 +1,13 @@
+# The units of system design, and the currencies: what every UnitPad sheet starts with (named in `unitpad.json`).
+# In the Numbat command line, `use units::systems` in your `init.nbt` brings them in. One `use` per line, in order; a module
+# may rely on any module listed above it.
+
+# Currency is Numbat's: its `USD` and the other currencies, priced by the exchange rates UnitPad feeds it.
+use units::currencies
+
+# Count units, each its own dimension, by kind of thing counted.
+use units::systems::workload
+use units::systems::storage
+use units::systems::network
+use units::systems::compute
+use units::systems::aws

package/package.json

@@ -1,6 +1,64 @@
 {
   "name": "@unitpad/modules",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "The numbers UnitPad sheets import with `use`: latencies, throughputs, sizes, prices and limits, each with its source.",
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "modules",
+    "unitpad.json"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    "./unitpad.json": "./unitpad.json",
+    "./modules/*": "./modules/*"
+  },
+  "keywords": [
+    "unitpad",
+    "numbat",
+    "units",
+    "latency",
+    "throughput",
+    "capacity-planning"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UnitPad/modules.git"
+  },
+  "homepage": "https://github.com/UnitPad/modules#readme",
+  "bugs": {
+    "url": "https://github.com/UnitPad/modules/issues"
+  },
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "test": "node --test tools/*.test.mjs",
+    "lint": "eslint .",
+    "lint:md": "markdownlint-cli2",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "api": "node tools/api.mjs",
+    "api:update": "node tools/api.mjs --update",
+    "api:release": "node tools/api.mjs --release",
+    "values": "node tools/values.mjs",
+    "values:update": "node tools/values.mjs --update",
+    "values:release": "node tools/values.mjs --release",
+    "numbat": "node tools/install-numbat.mjs",
+    "check": "npm run lint && npm run lint:md && npm run format:check && npm test && node tools/check-docs.mjs && node tools/style.mjs && node tools/api.mjs && node tools/values.mjs && node tools/pack-check.mjs",
+    "check:docs": "node tools/check-docs.mjs",
+    "style": "node tools/style.mjs",
+    "check:pack": "node tools/pack-check.mjs",
+    "stale": "node tools/stale.mjs",
+    "links": "node tools/links.mjs"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.12.0",
+    "globals": "^17.13.0",
+    "markdownlint-cli2": "^0.23.3",
+    "prettier": "^3.9.9"
+  }
+}

package/unitpad.json

@@ -0,0 +1,35 @@
+{
+  "$comment": "What UnitPad reads from this package. `format`: the version of this file's own shape; it only grows (a new field is optional), and a package whose format UnitPad does not know is refused at build, not at run. `prelude`: the modules every sheet starts with (a module made of `use` lines is expanded, so one id can stand for many); they are not importable and not listed in the Modules menu. `types`: a module's type is the first part of its path (`throughput::s3` is a `throughput`); the Modules menu lists the types in this order, under these headings, and a type not listed follows, alphabetically, under its name with a capital.",
+  "format": 1,
+  "prelude": ["units::systems"],
+  "types": [
+    {
+      "id": "latency",
+      "title": "Latency"
+    },
+    {
+      "id": "throughput",
+      "title": "Throughput"
+    },
+    {
+      "id": "size",
+      "title": "Size"
+    },
+    {
+      "id": "count",
+      "title": "Count"
+    },
+    {
+      "id": "capacity",
+      "title": "Capacity"
+    },
+    {
+      "id": "availability",
+      "title": "Availability"
+    },
+    {
+      "id": "cost",
+      "title": "Cost"
+    }
+  ]
+}