umlmeta 0.2.0__tar.gz

umlmeta-0.2.0/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in 
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

umlmeta-0.2.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: umlmeta
+Version: 0.2.0
+Summary: Clean-room Python UML 2.5.1 / SysML v1 metamodel, XMI readers and writers, and the SysML v1 to v2 transformation
+Author-email: "Jon R. Fox" <jon.fox@drfox.com>
+License-Expression: MPL-2.0
+Project-URL: Homepage, https://github.com/mycr0ft/umlmeta
+Project-URL: Repository, https://github.com/mycr0ft/umlmeta
+Project-URL: Issues, https://github.com/mycr0ft/umlmeta/issues
+Project-URL: Changelog, https://github.com/mycr0ft/umlmeta/blob/master/CHANGELOG.md
+Keywords: uml,sysml,metamodel,xmi,cmof,emof,modeling,mof,step
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: xmi
+Requires-Dist: lxml>=4.9; extra == "xmi"
+Provides-Extra: dev
+Requires-Dist: lxml>=4.9; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# umlmeta
+
+Clean-room Python implementation of the **UML 2.5.1 metamodel** and the **SysML v1 → v2
+transformation**, generated from OMG-published XMI and validated against the
+[sysmlpy](https://github.com/mycr0ft/sysmlpy) v2 reader.
+
+No vendor tooling, no UML/SysML libraries — the generated packages are pure
+stdlib, and every semantic in them is traceable to an OMG document.
+
+## What's inside
+
+| Piece | What it is | Checks |
+|---|---|---|
+| `umlmeta.uml25` (src/umlmeta/uml25.py) | UML 2.5.1 metamodel as Python classes — generated by `generate.py` from the OMG UML XMI: 242 metaclasses, 620 reference descriptors, 22 derived unions computed at read time, 328 hidden association ends (the subset/redefine lattice is closed by the generator), 449 OCL constraints carried as metadata | `check.py` 45 |
+| `umlmeta.standard_profile`, `umlmeta.sysml`, `umlmeta.uaf`, `umlmeta.uaf13` | StandardProfile + SysML v1 + UAF 1.2 (256) + UAF 1.3 (272) profile stereotypes, generated by `generate_profiles.py`; stereotypes fold their base metaclasses via Python inheritance, including cross-profile folds (UAF generalizes SysML stereotypes, e.g. `Capability(sysml.Block, ...)`); 1.3 adds the Mission-domain stereotypes and carries the `http://www.omg.org/spec/UAF/20241101/UAF` URI | `check_profiles.py` 60 |
+| `umlmeta.v1_to_v2` | Clean-room SysML v1 → v2 **textual-notation emitter** anchored to OMG *SysML v2.0 Beta 4, Part 2: SysML v1 to SysML v2 Transformation* (ptc/2025-04-07). Every emitted form is calibrated against sysmlpy; anything without a normative mapping **raises `UnmappedFeature` instead of guessing** | `check_v1_to_v2.py` 47 |
+| `umlmeta.xmi21` | XMI 2.1/EMF instance reader (dialect-tolerant: unprefixed containment, EMF feature defaults, cross-file `href` markers, stereotype applications) → feeds the emitter end-to-end | `check_dodaf.py` 32 |
+| `umlmeta.mdzip` | MagicDraw/Cameo `.mdzip` scrape + forensics: member inventory, model-snapshot extraction with Nomagic→OMG namespace aliasing, proxy/project-usages (`local:/PROJECT-…` dependencies), version-era fingerprints (ID prefixes like `_2021x_2_…`), and hex/base64 payload extraction (SVG/PNG/JPEG/ZIP) with a manifest | `check_mdzip.py` 28 |
+| `umlmeta.mdzip_import` | `.mdzip` → `umlmeta.uml25` objects: merges delta-snapshot members (keep-last dedup), retags Nomagic's XMI-2.0/xsi spellings to the reader's dialect, injects `xmi:type` from tags/features and coerces raw-ID types (metamodel-as-map + property signature), scrubs cross-project/name-typed/profile-layer refs into synthetic external markers, and delegates to `read_xmi21` — provenance (usages, eras) travels with the model | `check_mdzip_import.py` 26 |
+| `umlmeta.mdzip_diff` | Semantic diff of two .mdzip files: flatten to (metaclass, qualified-path, feature) records with xmi:ids discarded entirely, then match by qualified path → metaclass+name moved → same-owner similarity → cross-owner same-name similarity, and report added/removed/renamed/moved/feature-changed. Survives TeamworkCloud-style id churn by construction | `check_mdzip_diff.py` 12 |
+| `umlmeta.xmi_write` | XMI 2.1/EMF instance writer — the read/write pair round-trips both OMG dialects (DoDAFLibrary 2.1 form and MeasurementsLibrary 2.5.1-era form) with **canonical structural parity** (`canon.py`); writes stereotype applications (both forms, tags, `_URI`/`_EXTENSIONS`-driven) and profile applications; `write_cameo_xmi(...)` adds the Cameo/MagicDraw 2024x dialect (UML 2.5.1 namespace pair, `uml:Model` project wrapper, P10 applications — see `docs/CAMEO_XMI.md`) | `check_xmi_write.py` 48, `check_xmi_cameo.py` 15 |
+| `umlmeta.bpmn` | BPMN 2.0.2 metamodel — OMG publishes BPMN as CMOF XMI (`BPMN20.cmof`), not a UML profile; `generate_bpmn.py` is a clean-room CMOF generator: 137 classes, 9 enums, 193 associations, opposite wiring, deliberately NOT UML Elements | `check_bpmn.py` 25 |
+| `umlmeta.mm_write` | CMOF writer — reconstructs OMG `BPMN20.cmof` from the generated metamodel with **canonical structural parity** (`canon.py`, member order as set); `_SYNTH` carries the raw serialization forms the runtime tables don't. `write_emof` adds the EMOF dialect (MOF 2.0/XMI §6.5.2 rules: derived and defaults not serialized, no Associations) | `check_cmof_write.py` 20, `check_emof_write.py` 18 |
+| `umlmeta.derived` | UML 2.5.1 normative derivations over `umlmeta.uml25` objects (spec OCL anchors): ownership chains, qualified names (template-aware), generalization closures, normative member (inherited/imported), redefinition-aware derived-union evaluation | `check_derived.py` 42 |
+| `umlmeta.query` | Query helpers over loaded instance graphs: deterministic containment walk, `find` (metaclass by class or name, stereotype labels, qualified names, predicates), `stereotypes` label resolution | `check_query.py` 19 |
+| `umlmeta.sysml2` | SysML v2 abstract syntax (KerML + SysML), generated by `generate_sysml2.py` from the OMG normative CMOF XMI (conformance **R2**): 175 classes, KerML ownership/membership wiring at runtime (OwningMembership/FeatureMembership containment, FeatureTyping typing, Subclassification specialization), derived-union reads (`ownedElement`, `feature`) computed live | `check_sysml2.py` 26 |
+| `umlmeta.v1_to_v2_as` | SysML v1 → v2 **abstract-syntax transformer** (conformance **R3**, ptc/2025-04-07 §2): transforms `umlmeta.uml25`+`umlmeta.sysml` objects (R1 artifacts) into `umlmeta.sysml2` objects (R2 artifacts) — Block→PartDefinition, Property→PartUsage/AttributeUsage/OccurrenceUsage via FeatureMembership + FeatureTyping, Generalization→Subclassification, Comment→Documentation; one AS object per v1 element, same honesty rule as the textual emitter | `check_v1_to_v2_as.py` 33 |
+
+**481 checks, all green.** `REPORT.md` is the detailed build journal: dialect facts,
+mapping tables with spec anchors, calibration evidence, and honest elisions.
+
+## Quick start
+
+The check suites for the metamodel and profiles are stdlib-only; the emitter
+suites validate with [sysmlpy](https://github.com/mycr0ft/sysmlpy) (the
+authoritative SysML v2 reader), and the generator/reader need `lxml`:
+
+```bash
+python check.py                 # UML metamodel: 45 checks (stdlib only)
+python check_profiles.py        # profiles (Std + SysML + UAF 1.2 + UAF 1.3): 60 checks (stdlib only)
+python check_bpmn.py            # BPMN 2.0.2 CMOF metamodel: 25 checks (stdlib only)
+python check_sysml2.py          # SysML v2 abstract syntax: 26 checks (stdlib only)
+python check_emof_write.py      # EMOF writer: 18 checks (stdlib only)
+python check_ocl.py             # OCL translation: 19 checks (stdlib only)
+
+# these need the sysmlpy reader and/or the OMG corpora
+$SYSMLPY_PYTHON check_v1_to_v2.py    # v1->v2 emitter: 47 checks
+$SYSMLPY_PYTHON check_dodaf.py       # XMI end-to-end: 32 checks
+                                #   (needs lxml + DoDAFLibrary.xmi, see REPORT Part 4)
+
+# the generators need lxml and write into src/umlmeta/
+$LXML_PYTHON generate.py           # regenerate src/umlmeta/uml25.py
+$LXML_PYTHON generate_profiles.py  # regenerate the profiles
+```
+
+The check scripts print every assertion; a failing assertion names the mapping.
+`check_v1_to_v2.py` also writes `vehicle_example_v2.sysml`, `wave3_example_v2.sysml`,
+and `wave4_example_v2.sysml` — worked examples of the emitted notation.
+
+## Repo layout
+
+```text
+pyproject.toml           distribution "umlmeta", MPL-2.0, src layout
+src/umlmeta/             the importable package
+  uml25.py               generated UML 2.5.1 metamodel (stdlib-only, self-contained)
+  standard_profile.py    generated StandardProfile stereotypes
+  sysml.py               generated SysML v1 profile stereotypes
+  uaf.py                 generated UAF 1.2 UAFML stereotypes (folds sysml bases)
+  uaf13.py               generated UAF 1.3 UAFML stereotypes
+  sysml2.py              generated SysML v2 abstract syntax + KerML runtime (R2 artifact)
+  bpmn.py                generated BPMN 2.0.2 metamodel (reuses uml25 descriptors)
+  v1_to_v2.py            SysML v1 -> v2 textual emitter (mapping authority: ptc/2025-04-07)
+  v1_to_v2_as.py         SysML v1 -> v2 abstract-syntax transformer (R3; constructs sysml2)
+  xmi21.py               XMI 2.1/EMF instance reader -> uml25 objects
+  xmi_write.py           XMI 2.1/EMF instance writer (canonical parity vs OMG corpus)
+  mm_write.py            CMOF + EMOF metamodel writers (canonical parity; spec-rule checks)
+  derived.py             UML 2.5.1 normative derivations (owners, qualified names, unions)
+  query.py               query helpers (walk / find / stereotypes / exists / count)
+  canon.py               shared canonical XML comparator (writer oracles)
+  ocl_translator.py      clean-room OCL-to-Python translator
+  mdzip.py               MagicDraw/Cameo .mdzip scrape + forensics
+  mdzip_import.py        .mdzip -> uml25 objects (provenance travels with the model)
+  mdzip_diff.py          semantic diff of two .mdzip files
+  boxes_view.py          v1 data -> SysML v1 diagrams via diagramboxes
+generate.py            UML 2.5.1 metamodel generator (OMG UML.xmi -> src/umlmeta/uml25.py)
+generate_profiles.py   profile generator (StandardProfile.xmi, sysml.xmi, UAF.xmi -> src/umlmeta/*.py)
+generate_sysml2.py     SysML v2 AS generator (OMG normative CMOF XMI -> src/umlmeta/sysml2.py)
+generate_bpmn.py       CMOF generator (OMG BPMN20.cmof -> src/umlmeta/bpmn.py)
+check*.py               eighteen check suites (481 checks; corpus suites need /mnt/TBFox, mdzip suites need MDZIP_CORPUS / MDZIP_REVISIONS)
+calibrate_v2.py        textual-form calibration harness for sysmlpy
+REPORT.md              build journal: dialect facts, mapping tables, evidence
+PLAN.md                plan for the exporter/QoL waves (E1-E6: XMI/CMOF/EMOF writers, stereotype writing, derived unions, query helpers)
+```
+
+## Install
+
+```bash
+pip install umlmeta              # the generated metamodel and the library
+pip install "umlmeta[xmi]"       # + lxml, for the XMI/CMOF/EMOF readers and writers
+```
+
+The generated metamodel modules are pure stdlib; `lxml` is only needed by the
+readers, writers and generators.
+
+```python
+from umlmeta import uml25
+from umlmeta import derived, query
+```
+
+## Clean-room discipline
+
+- The generator and emitter are written from **normative OMG text only**
+  (UML 2.5.1 XMI, profile XMI, the ptc/2025-04-07 transformation spec).
+  Reference extractions and example XMI corpora are **kept out of the
+  repository** (e.g. the local `transition.txt` spec dump is git-ignored).
+- The only instance-model corpus used for reader tests is the
+  OMG-published `DoDAFLibrary.xmi` (UPDM example). Third-party commercial
+  book models are **excluded on copyright grounds**.
+- The emitter follows an **honesty rule**: elements with no normative
+  mapping raise `UnmappedFeature` naming the v1 metaclass rather than
+  guessing, and spec gaps (e.g. ProxyPort, SYSML2_-329) surface as
+  explicit comments.
+
+## Related
+
+- [mycr0ft/sysmlpy](https://github.com/mycr0ft/sysmlpy) — the SysML v2
+  reader used as the validation oracle for every emitted textual form
+- [mycr0ft/ams-gra](https://github.com/mycr0ft/ams-gra) — consumer of the
+  emitter (AMS GRA v14.0 SysML v2 model, built via this toolchain)
+- [mycr0ft/ams-gra-sysml](https://github.com/mycr0ft/ams-gra-sysml) — the
+  SysML v2 model itself
+
+## License
+
+MPL-2.0 — see [LICENSE](LICENSE).