colregs 0.1.0 → 0.2.0

package/LICENSE

@@ -1,34 +1,202 @@
-MIT License
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Copyright (c) 2026 Mark Brannan
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+   1. Definitions.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING OUT OF
-OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
 
----
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
 
-The MIT licence above covers this compilation: the JSON structure, the
-predicates, the fixtures and the tests.
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
 
-The rule text in `data/rules.json` and the diagrams in `images/NRHB_*.png` are
-works of the United States Government and are not subject to copyright in the
-United States (17 U.S.C. 105). The `*arc.gif` files have unverified
-provenance — see PROVENANCE.md.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Mark Brannan
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
 
-This package is not authoritative and is not endorsed by the US Coast Guard.
-Navigate by the published rules.

package/PROVENANCE.md

@@ -7,8 +7,10 @@ publications. Nothing here is authoritative: consult the published rules.
 
 - **Source:** USCG Navigation Center, *Navigation Rules, International —
   Inland* (amalgamated), <https://www.navcen.uscg.gov/navigation-rules-amalgamated>
-- **Retrieved:** 2026-08-29
-- **Scope:** the **International** text only. The amalgamated page marks
+- **Retrieved:** 2026-09-04 (re-fetched to add Rules 1-19; originally 2026-08-29
+  for Part C)
+- **Scope:** the **International** text only, now covering Parts A and B
+  (Rules 1-19) and Part C (Rules 20-31). The amalgamated page marks
   inland-only inserts and international-only variants inline; inland text was
   removed and international variants kept. Nothing was paraphrased.
 - **Rights:** a work of the US Government, not subject to copyright in the
@@ -17,6 +19,28 @@ publications. Nothing here is authoritative: consult the published rules.
   reconstruct it from memory, `rules.json` records it under `gaps` and the
   paragraph is omitted. 24(g) covers inconspicuous, partly submerged tows and
   is outside the applicability table in this release.
+- **Known quirks kept verbatim:** the source's own text of Rule 1(c) repeats
+  "special rules ... special rules made" and Rule 13(b) reads "coming up with
+  a another vessel" (sic), and Rule 10(c) reads "A vessel, shall so far as
+  practicable, avoid crossing traffic lanes" — comma placement that doesn't
+  match the official COLREGS text. All three are transcribed exactly as the
+  source HTML has them rather than silently corrected; confirmed by
+  re-fetching and grepping the raw source HTML directly (not the rendered
+  page) on 2026-09-05. Rule 3(l)'s quoted term ("restricted visibility") is
+  also curly in the source and transcribed as such — that part of this note
+  previously and incorrectly claimed it was the only curly-quoted term in the
+  corpus; Rule 3(m)'s quoted term (“Wing-In-Ground (WIG)”, with `craft`
+  outside the quotes) is the other, corrected to match the source on
+  2026-09-05 after having been transcribed with straight quotes and `craft`
+  inside the term.
+- **Inland-only inserts deliberately absent:** the source marks Inland
+  text with `‹‹ ››`. Rule 21(a) and 21(b)'s "vessel of less than 12 meters
+  … as nearly as practicable to the fore and aft centerline" clauses and
+  Rule 23(b)'s "where it can best be seen" are such inserts and are not in
+  `rules.json`; Rule 29(b)'s "similar" is in the International text and is
+  kept. Verified 2026-09-05 against the raw source HTML, 33 CFR 83 (eCFR)
+  and the 1972 treaty text (UNTS Vol. 1050) — see
+  `docs/verification/2026-08-30-q6-q8.md`, Claim 1 correction.
 
 ## Diagrams — `images/NRHB_*.png`
 
@@ -33,7 +57,7 @@ Two of the 38 (`NRHB_25_b.png`, `NRHB_27_ei.png`) are served by the USCG but
 not linked from the page; they were fetched by name. Two more
 (`NRHB_23_e.png`, `NRHB_24_j.png`) illustrate Great Lakes and Western Rivers
 paragraphs and are unmapped in this international-only release — they are kept
-because the inland ruleset will want them.
+because the `us/inland` jurisdiction will want them.
 
 ### The `NR_*` / `NRHB_*` prefix question, resolved
 
@@ -43,18 +67,27 @@ diagrams the USCG now serves as `NRHB_25_b.png` and `NRHB_27_ei.png` — an
 older filename for the same images, not a different source. This package uses
 the current USCG names throughout.
 
-## Arc diagrams — `images/*arc.gif` — **unresolved**
+## Arc diagrams — `images/*arc.gif`
 
-`mastheadarc.gif`, `portarc.gif`, `stbdarc.gif`, `sternarc.gif` and
-`towingarc.gif` were carried over from `signalk-auto-nav-lights`. They are
-believed to be USCG illustrations, but the page that served them no longer
-exists and no archived original has been located, so their provenance and
-rights are **unverified**. `data/images.json` marks them
-`"provenance_status": "unresolved"`.
+- **Source:** USCG Navigation Center, *Navigation Rules Arcs of Visibility*,
+  <https://www.navcen.uscg.gov/navigation-rules-arcs-of-visibility>, which
+  serves the five files at
+  `https://www.navcen.uscg.gov/sites/default/files/images/nr_pics/Arcs/<name>`
+  as the rollover states of its Rule 21/22 diagram.
+- **Retrieved:** 2026-09-05 — fetched from the live USCG server and compared
+  byte-for-byte (`cmp` and SHA-256) against the copies carried over from
+  `signalk-auto-nav-lights`: identical, all five.
+- **Rights:** US Government work, public domain (17 U.S.C. 105).
+- Captions are the page's own image-map `alt` text; each file is mapped to
+  the Rule 21 definition it illustrates (`21(a)` masthead, `21(b)`
+  sidelights, `21(c)` sternlight, `21(d)` towing light, plus `24(a)(iv)`
+  for the towing light's placement).
 
-They are decorative here: the arcs themselves are data, in `data/lights.json`
-under each light's `arc`. If provenance cannot be established, delete the GIFs;
-nothing in the package depends on them.
+The same filenames existed on the pre-Drupal site under
+`navcen.uscg.gov/mwv/navrules/` (Wayback has `mastheadarc.gif` from
+2004-10-15), which is why an earlier release could not locate the page and
+recorded them as unresolved. They remain decorative: the arcs themselves are
+data, in `data/lights.json` under each light's `arc`.
 
 ## SignalK paths