Skip to content

Releases

v0.6.0

Choose a tag to compare

@samuelduchesne samuelduchesne released this 10 Nov 20:41

This release makes the building's orientation a sweepable control, adopts the idfkit visual identity, and corrects three reading errors: the TM59 night window under daylight saving, the economizer's flow limit on stacked storeys, and two unit-lettering faults. Every v0.5.0 permalink still opens to the same building.

Features

  • North axis can be studied, surveyed and pulled round the whole turn (#113). A study draws a closed curve on the card, 8 bearings then 16, with its extremes lettered as compass bearings. Either axis of an E-02 survey can be North axis, and the ground has no seam at north; a narrowed extent may run through north, so 300° to 60° is cut the short way round. The pull ranks it like any other control, turning the building 18° clockwise.

  • The study curve stands under its slider and can be probed (#105). The plot spans the full width of the face above it, so each position on the curve sits under the same position on the slider. Hovering letters the reading at that position, interpolated between solved samples and marked ≈; clicking sets the control there, snapped to its step.

  • The link records whether the model console is open (#109). An open console adds desk=open to the address and to Share. A closed console adds nothing, so existing links are unchanged. Kept schemes do not store it.

  • The sheet wears the idfkit identity at identity-2026.5 (#102), with the Shoebox lockup at the head of the title block. Colours, typefaces, favicons and the social image come from the standard; the drafting sheet's own colour names survive as aliases.

Fixes

  • TM59 criterion b reads the right nine hours under daylight saving (#111). EnergyPlus stamps hourly output in standard time, so with daylight saving observed the window read was 00:00 to 09:00 local instead of 23:00 to 08:00. Every TM59 reading now places each stamp on the local clock. Runs without daylight saving read exactly as before.

  • TM59 criterion a counts an hour whose ∆T is exactly 0.5 K (#111). Floating-point representation had dropped such hours for 127 of the 402 thresholds between running means of 10 °C and 30 °C.

  • The economizer's cooling flow limit covers every storey (#101). It was sized on one storey's volume, so above a zone multiplier of 1 the system ran at the limit without warning: 2,595 of 2,600 occupied hours in one reported scheme. Single-storey desks write the same IDF as before.

  • The default desk runs with no warnings (#112). Two Other Equipment series were still requested after the objects that produce them were removed.

  • Landmark tooltips, slider descriptions and the airtightness line follow the unit system (#108). The arithmetic line had mixed IP area and volume with an SI density, giving 35.3 times the coefficient it explains.

Changes

  • Links are now v2 (#113). A v1 link carrying northAxis=360 opens at 0°, the same building; a v2 link carrying 360 is refused.
  • "Cost" is now "Utility cost" in studies, surveys and the kept-scheme column (#104). The link token cost is unchanged.
  • The duration curve's cursor follows a hovering mouse (#106); a press still sets it on a touch screen.
  • MIT licence added, and the README corrected against the code (#110).

v0.5.0

Choose a tag to compare

@samuelduchesne samuelduchesne released this 23 Oct 17:25

This release lets the desk solve against a weather file the reader supplies, and it draws each run in seven views. A CIBSE design summer year can now go onto the desk without any byte of it leaving the reader's machine. The plate draws one run as seven charts, and the survey draws each standard's published limit across the ground it cuts. Nothing breaks: every v0.4.0 permalink still decodes to the same building.

Features

  • Attach a weather file of your own (#85): an EPW, a DDY beside it, or the ZIP they came in, read in the page and passed to the same in-browser engine. No byte of the file reaches the network, which is the only arrangement under which a licensed CIBSE file can be used. The title block, site line, period, holidays, daylight saving rule and tariffs are read from the file's own records. Degree days are measured from its hours. Anything the file does not declare reads as an em dash.

    • A link carries a sixteen-character fingerprint of the file's records, never the file. A recipient who holds a different file is told so, with both files' descriptions, before any reading is drawn.
    • A file covering less than a year, such as a design summer year cut to 1 May to 30 September, is admitted. Each criterion it cannot answer is named. A calendar that asks for months the file lacks is refused before the run.
    • The browser keeps the file, gzipped in localStorage. It is re-attached automatically only where the link names it.
    • A kept scheme names the file it was solved against. Restoring it under a different file asks for that file instead of applying in place.
  • Seven ways to draw one run (#98): time series, psychrometric chart, adaptive comfort chart, carpet plot, duration curve, average day and energy signature, all read from one reading of the run. Changing view starts no solve. The view rides the link and is never kept on a scheme.

  • Published thresholds drawn across the surveyed ground (#83): on E-02, every standard's published limit for the chosen reading is drawn as its own isoline on the plan and on the relief, with the passing side hatched. Chasing a standard narrows the drawing to that standard's line.

  • Thermal lag as a study and survey reading (#90): hours from the summer design day's outdoor peak to the zone's peak. A desk that skips design days is refused, and the refusal names the press that restores them.

  • TM59 Category I as a reading (#86): studies and surveys can now be plotted against the stricter category for sensitive occupants. A threshold is matched on both criterion and category, because the two categories publish the same limit.

  • A note on every slider parameter (#94, #95): each one cites its EnergyPlus schema field where it has one. In the console the note opens from a + beside the control's label. The same notes appear in the survey's axis choosers.

Fixes

  • A console strip stays in its column (#91). Opening a study's reading chooser could re-balance the columns and move the strip, card and all, into the next one.

  • Units keep their case (#88, #90). Upper-casing made kilowatt-hours read KWH and hours read H (the henry).

  • The TM59 count and the description read as sentences (#88). A count of one criterion no longer reads "Of the 1 criterion", and the description's moves complete the building's sentence instead of standing without a verb.

Changes

  • Damping and thermal lag are measured only over a design day (#88). Over a year they compared summer's high with winter's low and read a lag of 504 hours at Boston-Logan. When no column is a design day, the schedule drops these rows.

  • A weather file without a DDY leaves the desk with no design days (#85), rather than Denver's design days under another file's title block. A run that asks for design days the desk does not have is refused, and the refusal is shown on the sheet.

  • The plate takes the height of its row (#88) instead of a fixed 268 px. Below 640 px of its own width it stacks under the model column rather than shrinking to a thumbnail.

  • The idfkit libraries move to 0.4.0 (#100). @idfkit/core, @idfkit/schemas and @idfkit/weather remain pinned exactly and together.

  • Commands that adopt an EnergyPlus release (#99), as idfkit-conformance declares them for this project. The build refuses to proceed when the engine package and src/version.js name different EnergyPlus release lines.

v0.4.0

Choose a tag to compare

@samuelduchesne samuelduchesne released this 15 Sep 14:32

The release that lets the sheet survey the building, not just solve it. E-02 cuts a ground through the desk out of real EnergyPlus runs, the sheet reads in SI or IP, and overheating is read against CIBSE TM59's moving comfort line. No breaking changes: every v0.3.0 permalink still decodes to the same building.

Features

  • A survey of the design space, on a second drawing (#54, #59): choose two controls and a reading, and E-02 cuts a ground through the desk from a real EnergyPlus run at every grid position, contoured on a plan and drawn in relief. Standing on a measured point moves E-01 to that design, and a ranking beside it names which of the ninety sweepable controls actually move the reading here. The contours between runs are declared as interpolation and no figure is read off them; a run that failed is a hole with its reason on it. Axes can be narrowed and swapped, visited designs restored, and a link carries the whole ground for the recipient to re-measure.

  • The sheet reads in SI or IP (#71): one control in the header stamp re-letters every figure on the page without moving the model. The IDF and every link are byte-identical either side of a switch, and a shared link carries no unit system, so one URL opens the same building for every reader. Eleven controls take a finer step that divides the old one exactly, so whole IP figures can be reached and existing links still land on the grid.

  • Overheating read against CIBSE TM59 (#46): a Room type on the Gains strip writes the method's occupancy, equipment and lighting profiles, and the scoreboard counts hours above a comfort line that moves with the outdoor running mean rather than a fixed number. It letters how many criteria were cleared out of how many it could read, never a pass or fail, since one zone on attached weather is not the method's assessment.

  • Studies plot the quantity you choose (#47): every open study shares one of eleven quantities, from temperature and TEDI/CEDI to cost, carbon and the TM59 criteria. A quantity the desk cannot produce stays listed with the reason and the action that enables it, and links now carry the chosen quantity and the open studies.

  • Study and survey the plant and the tariff (#81): seasonal efficiency, both COPs, the two prices and the grid intensity now carry Study and are axes on E-02, at no run beyond the one each shape needs. A reading a priced control cannot move is refused, with the readings it can.

  • Report a problem from the sheet (#64): a Report button gathers the link, build, engine errors, refusals in view and the last twenty actions into a slip the reader reads before one press opens a prefilled GitHub issue. That press is the only moment anything leaves their machine, and it works even when the engine fails to load. New issues are then sorted by Claude and labelled by idfkit-bot, which applies only what survives a check against the repository and never overrides a maintainer's label.

Fixes

  • A window-to-wall ratio now includes its frame, and a large framed window no longer stops the run (#58). The ratio is the rough opening, as ASHRAE 90.1 measures it, so a wider frame means less glass rather than a window bigger than its wall. Desks without a frame write the same file.

  • A heating setpoint above the cooling one no longer kills the run (#57). The System strip is blocked until the two are level or apart, instead of failing in the first warmup timestep.

  • Shades and rooflights too small to build are refused (#58, #62). Fins, overhangs and curbs 1 cm deep, and linear rooflight bands under 1 cm at the lowest skylight ratio, were deleted by EnergyPlus while the drawing still showed them.

  • A study no longer mixes a building with a system and one without (#57). A position where the swept control takes its own channel out of the model is refused and drawn as a gap with its reason, rather than measured.

  • The title block's Timestep cell follows the Solver strip (#77). It was lettered once at boot and never updated.

Changes to how the sheet reads

  • The sheet reads at a glance (#56): every reading, verdict, absence and refusal stays in view, while method notes, derivations and citations sit one press away in a fold under what they explain. Visible prose falls from about 2,700 words to under 600.

  • The idfkit libraries move to 0.3.0 (#53, #79): @idfkit/core, @idfkit/schemas and @idfkit/weather are pinned exactly, and every IDF and run bundle stamps the new version. Eight desk positions hold the same objects field for field; the file differs only in comment alignment and the order of eleven types, which run to byte-identical results under EnergyPlus 26.1.0.

v0.3.0

Choose a tag to compare

@samuelduchesne samuelduchesne released this 04 Sep 00:06

The release that stops the Air strip asserting its own answer. Twenty-one commits since v0.2.0: a second air model that computes the flow instead of being told it, a title block that can be signed, a station reader that refuses what it cannot read rather than fatalling the run, and a heat balance that says out loud which way it points. No breaking changes; every v0.2.0 permalink still decodes.

Features

  • An AirflowNetwork air model beside the scheduled one (#43): the Air strip now states its subject two ways. Either you state an air change rate, or a pressure network computes the flow from wind and stack effect at every timestep, out of an envelope leakiness and an openable area per wall — which is what lets the desk answer whether it matters that the openable window is on the west elevation rather than the south. The engine simulates one or the other and never both, so the model that is out has its objects deleted rather than zeroed. Costs about 20 ms on a design day and 3.1x on a year.

  • The title block can be signed (#40): type a name into Drawn by and every model the desk hands over carries it, at the head of the IDF and in the run bundle's MANIFEST.txt. The cell is empty until you fill it — a title block names whoever drew that drawing, and here that is whoever is at the console. The name is kept in this browser and never in a link, so a scheme you send carries the building and not whoever drew it. Signing runs nothing and moves no reading.

  • The page says who built it: the head's stamp gains a Toolkit row beside Engine, Runtime and Upload, so the page states what it is a demo of without anyone opening the Disclosure band.

  • The scoreboard's em dashes can be pressed: a desk that ships free-running used to meet nine em dashes and the same grey sentence beside each one. One note above the table now carries the fix as a press, escalating from "patch System in" to "attach a weather file", and the kept-schemes shelf carries the same offer.

  • Page views are counted through GoatCounter — no cookie, no identifier, nothing cross-site, and the URL fragment is not recorded, so a shared desk never lands in the table as its own page.

Fixes

  • A station whose design conditions cannot be read is refused, instead of fatalling the run (#42). Searching Boston put WMO 994971 at the top of the list, and attaching it stopped the engine before a single hour was simulated: the site publishes no annual cooling condition at all, so the reader fell back to the first day of the right season — a January day — carrying the literal text N where onebuilding had no number to publish. EnergyPlus rejects N in a numeric field, and the first thing a new reader did on this page could be watch it fail.

    The obvious fix was the wrong one: the name the reader used to ask for, Ann Clg 1% Condns DB=>MWB, is published for only 69 sites in 120, so simply requiring it would have refused 51 of them, 39 working perfectly. The sheet now declares an ordered list of annual design days it will accept, at the severity it has always claimed, and takes the first one published whose numbers parse. Measured over the same sample: 108 attach, 12 are refused, and every one of the 12 is a marine 99xxxx station publishing no annual cooling condition whatsoever.

  • The plate letters the design day it actually got. Any non-winter day was lettered 1% clg db, so 39 sites in 120 were being sized on a .4% dewpoint day under a label claiming otherwise.

  • A refused station says what to do instead, reopening the picker on the nearest other stations — two clicks from the refusal to a solved Boston-Logan.

  • A link naming an unusable station says why. The generic "the whole link was set aside" was being lettered over the specific sentence the attach had just written into the same status line.

  • The revisions section no longer overflows a narrow screen. A wide unwrapped code block was winning the grid's default min-width: auto and pushing the whole block past the viewport instead of scrolling inside its own overflow.

Changes to how the sheet reads

  • The heat balance says which way it points (#38). Direction was carried only by the hue and by the absence of a minus sign, which is a colour-only encoding of the one fact the rail exists to state: in monochrome, under forced colours, or read aloud as a swatch, a positive term said nothing whatever about being positive. The convention is now stated under the rail's head, and every rail figure carries in or out beside its watts. The head also says what the ± is — one side of the balance, not the two netted.

  • Two rail readings say on the strip that they are not the variable they are named after. System air transfer is reported per building and divided back down. Air energy storage enters the balance negated and is relettered Air energy release, because under the variable's own name a reading of −400 W said "storage" and "out" in one breath. Neither transformation was wrong; neither was checkable.

  • A control belonging to the model that is out is no longer drawn (#44). Dimming a withdrawn block said "inert right now" where the truth is "belongs to the other instrument", and a dimmed slider is still draggable, still in the tab order and still moves under an arrow key. Applied to all three channels with that shape: Air's two models, Glazing's simple unit against its layered one, and the rooflights' own glass. A control whose reviving control is adjacent is still dimmed rather than withdrawn.

  • The run log stays in view down the sheet, so a solve fired from the scoreboard no longer reports its stages and wall clock to a margin scrolled off the top.

  • The lede leads with the capability rather than with Denver, since the first climate named is the one a reader takes the tool to be about.

  • The title block says there is no simulation server, rather than Upload: None — which on a page that simulates a building read as an empty field, and so as an affordance this page does not have.

  • The scoreboard and the kept-schemes shelf read as tables again: each standard's name heads a banded section, and each shelf figure is headed over its own column instead of over the empty delta beside it.

Deployment

  • Only a tag publishes the site (#50). shoebox.idfkit.com is a released issue of the drawing and nothing else, for the same reason the title block carries a revision at all. Every other push to main now publishes the development channel at shoebox.idfkit.com/dev/, and opening a pull request publishes a preview at shoebox.idfkit.com/<number>/. A release is the same artefact that has been served under /dev/ since it was merged, moved to the root.

Upgrade notes

Nothing to do. This is a web page, not a package: open shoebox.idfkit.com and you have it. Permalinks minted under v0.2.0 still decode — the link format is still v1, since the new controls are additions under delta encoding and every new channel ships bypassed.

v0.2.0

Choose a tag to compare

@samuelduchesne samuelduchesne released this 19 Aug 15:27

The first tagged release of the shoebox: a one-page, client-side EnergyPlus demo laid out as a drafting sheet, continuously deployed at shoebox.idfkit.com. Everything below shipped to main since 0.1.0 — six new channels and controls (adiabatic surfaces, skylights, per-wall glazing studies, custom holidays, layered glazing panes, a picker for the reading hour), a run of accessibility and mobile-layout fixes, and one deliberate breaking change to the permalink format, made before this tag existed to carry it.

⚠️ Breaking changes

1. The run period's beginMonth / endMonth link parameters are gone

Run from and Run to, two sliders describing one unbroken span, are replaced by a twelve-month calendar mask so a January-and-July run — sizing days without the spring between them — is expressible at all. The old pair could not describe that, and rather than carry it forward as a translated months= mask, it was dropped outright:

# Before (v1 link)
#v1&beginMonth=3&endMonth=5

# After (v1 link, same version — the mask needs no new encoding)
#v1&months=001110000000

A link naming either old key is refused whole, with the offending parameter named in the status line, rather than silently reinterpreted. Nothing had been published under the old format before this tag, so there is no link in the wild to migrate and no reason to spend a LINK_VERSION bump on one — this is the one and only release where that reasoning holds.

Added

  • The reading hour drags, and it has a picker. The plate's marker could be placed with a click; it can now be taken hold of and moved along the curve, with every meter on the rail, the balance total and the stamp under the plate re-lettering as it travels. Nothing is simulated — the run is already in hand and the hour is only a way of reading it — so a drag across a Denver year costs a re-read of an array rather than 8,760 hours of engine time. A press that never travels is still a click and still toggles the hour it names; a drag that ends where it began keeps the pin it just placed; and the address bar updates on release, never per frame, like every other gesture here.

    Under the plate there is now a bar carrying the instant, the hold, and two ways of naming another one. Named hours first, because "which hour" is a question the field already has stock answers to: EnergyPlus reports its own component loads at the time of the peak load, heating and cooling apart, so peak heating and peak cooling are the two a modeller arrives with; a results tool's period list offers summer and winter design weeks read off the weather file's statistics, which becomes the hottest and coldest outdoor hour; the zone's own warmest and coolest stand beside them because a free-running desk has no heating or cooling rate at all; and peak solar gain is the hour every glazing and shading control on the desk is arguing about. Each is found in the run that came back and letters the environment it landed in, with the value it reads there — on Denver's design days, peak heating at 24:00 on 21 December is 5.91 kW and peak cooling at 15:00 on 21 July is 2.18 kW.

    An offer the run cannot make states its reason where its stamp would have been and cannot be pressed. Bypass the System strip and both peaks say so rather than quietly handing back the least-cooled hour of the year under a label claiming the opposite — an argmax always returns something, which is exactly why it needs a gate.

    Then a calendar, every option of it walked out of the run's own timestamps, so it cannot name an hour the run does not hold. A date field was rejected when the marker was built, on the argument that it invites February the 30th and hour 25 purely to meet a refusal message; that was an objection to a free field, and there is nothing left here to refuse. It earns its place because the gesture cannot reach everywhere — an annual plate at ten hours to the pixel is physically unable to name 15:00 on 14 February, and a pointer is not the keyboard's instrument at all. It works coarse to fine: an environment opens at its own worst hour, a month or a day at that day's extreme, and only the hour field names an hour.

    The bar sits on the sheet rather than only on the rail for the reason the plate grew its marker in the first place: the rail is inside a console you have to open, and the hour is the single most movable thing about every figure on the page. It also says, on the sheet, when a pin could not be found in the new run and was released — until now the marker simply went from filled to hollow, which is not an explanation.

  • Any of the six surfaces can be made adiabatic, on a key of their own at the foot of the Fabric strip. A shoebox is almost never a free-standing object: it is one bay of a terrace, a middle floor of a stack, a corner unit with two party walls. Until now this desk could only say so about the floor, and every other surface was exposed whether the building it stood for was or not.

    The key is a plan with a section drawn through it. The four walls are the edges of the plan and turn with north, exactly as the glazing key's bars do; the roof and the floor are the two surfaces a plan cannot show — it is a horizontal cut and they are what it cuts through — so they are drawn as the section they would appear in, roof over floor, inside the square. Adiabatic is a doubled line, the way a party wall is drawn on any plan, and open to the weather is a single hairline. The axonometric is the same control: the three faces the viewpoint shows can be clicked to flip them, and every adiabatic surface is hatched like a cut — faintly, through the box, for the three facing away.

    On Denver's two design days, with the ideal unit and the internal gains in the path: the stock free-standing box carries 511.0 m² of exposed envelope at an A/V of 0.481 and asks for 82.5 kWh of heat. Take the east and west walls out as party walls and it is 371.6 m², 0.350 and 39.6 kWh — a little over half the heating for a building nobody moved a millimetre. Take the roof out instead, as a middle floor, and it is 47.8 kWh. Take all four walls out and the heating is 0.0 kWh against 99.0 kWh of cooling: a top-lit core, which is a real building and not one this page could previously describe at all.

    An adiabatic surface has no outside, and the engine refuses an opening cut into one, so the wall that goes out takes its glass, its overhang and its fins with it — the glazing key greys that wall and says The north wall is adiabatic, so there is nothing outside it to open onto, and Skylights blocks itself when the roof goes. The window-to-wall and skylight-to-roof ratios now divide by the surfaces that have an outside, which is what those ratios have always been measured over.

  • The sheet says which build of itself you are reading. The title block's Sheet cell has always carried a revision, and it was the string Rev A, hand-lettered and never once true. It now carries the build: E-01 · Rev 0.2.0 on a tagged release, and E-01 · Rev 0.2.0+cd5881e on the far more common case of a deploy from main with no tag on it, the sha being semver's build metadata — the same declared version, this particular build of it. It links to the release or the commit it names, so a reader who thinks a number looks wrong can now say which drawing the number was on, and the run bundle's manifest carries the same line beside the EnergyPlus version.

    The date under it is the revision's, taken off the commit. It used to be new Date() evaluated in the browser, which lettered "Issued" with the day the page happened to be opened: a drawing dated by whoever picked it up.

  • Every number a slider carries is now a box you can type in. The five seventy-six scales on the desk, the eight walls of its two plan keys and the five dimensions under the drawing — which are five of those same controls, drawn twice — all letter their value exactly as before, and every one of them is now also the way to set it: click the number, type, Enter. A slider cannot say an exact figure — width runs 4 to 40 m across about 200 px, which is 0.18 m to the pixel — so 12.00 m was a hundred presses of an arrow key away.

    Nothing is drawn around the box. No border, no fill, no spinner, no focus ring: the number reads as the lettering it always was, and the only thing that says it can be edited is the I-beam the cursor becomes over it. A sheet made of hairlines cannot afford eighty more rectangles to say the same thing.

    A typed value is brought onto the control's own face — clamped to the stops and snapped to the step, then rounded to the step's own decimals, because 0 + 3 * 0.05 is 0.15000000000000002 and that number would ride the permalink and be written into the IDF exactly as it stands. Anything that is not a number is refused whole and the model's own value comes back, the way a bad link is: no half-reading of 12abc. The unit and the zero word are accepted, since they are what the box says when it is not being typed in — 12 m means 12 m, and Solid closes a wall.

    Two quieter rules keep it honest. Focus shows the value itself rather than its lettering, because a height of 4.572 m reads as 4.57 m on a face ruled to two places and a reader who touched the box and left it alone would have silently trimmed 2 mm off the building — and the box compares what it gave against what it got back, so a touch-and-leave commits nothing whatever. And a redraw never types over the reader: a study tick landing or a station attaching redraws every face on the desk, and the one being edited is left alone until it is let go.

  • The layered glazing model has a pane count, and the window says what it came to. Two things were missing from the same strip. The layered model built a double unit and only a double unit — there was ...

Read more