koyu stats

Gives floor areas by level, reports semi-outdoor and outdoor separately, and totals by zone, by type and by use.

Arguments

koyu stats <entry.muro>

Takes one entry path.

Flags

None.

Output

npx tsx src/cli.ts stats examples/house/main.muro

L1
  /site/garden	南庭	garden	41.12 m2 (semi-outdoor, reported separately)
  /site/west	西側通路	yard	12.42 m2 (semi-outdoor, reported separately)
  /site/east	東側通路	yard	12.42 m2 (semi-outdoor, reported separately)
  /site/north	北側通路	yard	7.28 m2 (semi-outdoor, reported separately)
  /home/ldk	LDK	ldk	39.75 m2
  /home/hall1	玄関・階段	hall	13.25 m2
  Subtotal 53.00 m2
L2
  /home/bed1	主寝室	bedroom	26.50 m2
  /home/void	リビング上部	void (not counted as floor area)
  /home/hall2	2階ホール	hall	13.25 m2
  Subtotal 39.75 m2
Total 92.75 m2 (indoor floor area)
Semi-outdoor 73.24 m2 (balconies, external stairs and the like — whether they count is a matter of regulatory detail, so it is reported separately)
By zone (counted aggregation):
  /home	住戸	92.75 m2
  ldk: 39.75 m2
  hall: 26.50 m2
  bedroom: 26.50 m2
By use: exclusive 92.75 m2 (100.0%)

Reading it

Levels come out in ascending z. A level with no space that has a region gets no section at all.

A space's line is tab-separated: path / name / type / area. Areas are measured to wall centrelines.

Four kinds are handled differently.

Kind	Treatment
An indoor space	Counted into `Subtotal` and `Total`
`type:void`	No area is given; it prints `void (not counted as floor area)` and is not counted
`type:exterior`	Prints `(outdoor, not counted)` and is reported at the end as `Outdoor`
Semi-outdoor	Prints `(semi-outdoor, reported separately)` and is reported at the end as `Semi-outdoor`

Semi-outdoor is derived, not declared. A space that meets an exterior across an open boundary or a wall with air:1 is semi-outdoor. Whether a balcony or an external stair counts toward floor area is a matter of regulatory detail, so it is reported separately rather than counted.

The Outdoor line only appears when there are outdoor spaces.

npx tsx src/cli.ts stats examples/complex/main.muro

Total 31606.24 m2 (indoor floor area)
Outdoor 736.00 m2 (plazas, open ground and the like — not counted as floor area)

(An excerpt from the end of this building's full output.)

Three axes of aggregation

By zone totals per zone. A zone carrying site:1 does not appear here — the site is not a floor-area aggregation, and the site numbers are answered separately by koyu site.

The <type>: <area> lines that follow total by the type given as space's second positional argument. Types are an open vocabulary, so a misspelling is quietly counted as a different type. A line that says bedrom instead of bedroom does not error; it adds a row.

By use totals by the effective use inherited from the zone, with a percentage of the indoor floor area. A building that writes no use anywhere does not get this line.

Exit codes

Exit code	Meaning
0	Always (even with no spaces at all)
1	It could not be read because of a syntax or composition error
2	No file path was given (usage is printed)

stats never passes judgement. Whether the area is too large or too small, it returns 0. The floor area ratio comes out as a number from koyu site, and the verdict from koyu validate.

Arguments​

Flags​

Output​

Reading it​

Three axes of aggregation​

Exit codes​

See also​