Skip to content

Commit 09eb209

Browse files
ehsun-shclaude
andcommitted
Say who Maiman was
The rename commit put the reasoning in the architecture document, where only someone already reading §11 would find it. A visitor arriving at the README sees a name they have no way to parse — and an unexplained proper noun reads as arbitrary, which is the opposite of what choosing this one was for. So it goes where each audience actually lands: one line under the README tagline, a paragraph in the product context, and a sentence in the package docstring for whoever meets the project through `help(maiman)`. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 9d29177 commit 09eb209

3 files changed

Lines changed: 10 additions & 0 deletions

File tree

PRODUCT.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ result as an eye diagram, a BER number, an OSNR figure.
99
The engine exists and is validated: 295 tests, every physics block checked against a closed-form
1010
result in CI. What does not exist yet is the interface.
1111

12+
The name is **Theodore Maiman's**, who built the first working laser at Hughes Research
13+
Laboratories in May 1960 — a ruby rod that everything modelled here eventually descends from.
14+
It points the project at the physics rather than at a competing product, which the earlier name
15+
did not.
16+
1217
## Who uses it
1318

1419
**Primary: the practising link engineer.** Designs or verifies an optical link. Comes from

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
**An open-source, modular simulator for optical communication links and photonic systems.**
44

5+
*Named for **Theodore Maiman**, who fired the first working laser in May 1960 — the event every
6+
link in this simulator descends from.*
7+
58
[![CI](https://github.com/ehsun-sh/maiman-studio/actions/workflows/ci.yml/badge.svg)](https://github.com/ehsun-sh/maiman-studio/actions/workflows/ci.yml)
69
![status](https://img.shields.io/badge/status-pre--alpha-orange)
710
![license](https://img.shields.io/badge/license-Apache--2.0-blue)

src/maiman/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
"""Maiman Studio — simulation of optical communication links and photonic systems.
22
3+
Named for Theodore Maiman, who built the first working laser in May 1960.
4+
35
The public surface is deliberately small. Everything the GUI will eventually do
46
goes through it: if a feature is not reachable from here, it does not exist.
57

0 commit comments

Comments
 (0)