api581-engine 0.1.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- api581_engine-0.1.4/LICENSE +161 -0
- api581_engine-0.1.4/NOTICE.md +18 -0
- api581_engine-0.1.4/PKG-INFO +419 -0
- api581_engine-0.1.4/README.md +225 -0
- api581_engine-0.1.4/pyproject.toml +40 -0
- api581_engine-0.1.4/setup.cfg +4 -0
- api581_engine-0.1.4/src/api581/__init__.py +80 -0
- api581_engine-0.1.4/src/api581/_amine_tables.py +105 -0
- api581_engine-0.1.4/src/api581/_h2sh2_tables.py +161 -0
- api581_engine-0.1.4/src/api581/_slabx_worker.py +174 -0
- api581_engine-0.1.4/src/api581/_sulfidic_tables.py +517 -0
- api581_engine-0.1.4/src/api581/_sulfuric_tables.py +328 -0
- api581_engine-0.1.4/src/api581/acid_sour_water.py +238 -0
- api581_engine-0.1.4/src/api581/acscc_screening.py +88 -0
- api581_engine-0.1.4/src/api581/alkaline_sour_water.py +267 -0
- api581_engine-0.1.4/src/api581/amine_corrosion.py +277 -0
- api581_engine-0.1.4/src/api581/amine_screening.py +103 -0
- api581_engine-0.1.4/src/api581/api/__init__.py +4 -0
- api581_engine-0.1.4/src/api581/api/api520.py +88 -0
- api581_engine-0.1.4/src/api581/api/bundle.py +121 -0
- api581_engine-0.1.4/src/api581/api/consequence.py +102 -0
- api581_engine-0.1.4/src/api581/api/damage.py +1831 -0
- api581_engine-0.1.4/src/api581/api/dispersion.py +121 -0
- api581_engine-0.1.4/src/api581/api/effects.py +318 -0
- api581_engine-0.1.4/src/api581/api/events.py +96 -0
- api581_engine-0.1.4/src/api581/api/financial.py +115 -0
- api581_engine-0.1.4/src/api581/api/frequency.py +40 -0
- api581_engine-0.1.4/src/api581/api/inspection.py +96 -0
- api581_engine-0.1.4/src/api581/api/level1.py +238 -0
- api581_engine-0.1.4/src/api581/api/level2.py +74 -0
- api581_engine-0.1.4/src/api581/api/planning.py +17 -0
- api581_engine-0.1.4/src/api581/api/prd.py +190 -0
- api581_engine-0.1.4/src/api581/api/properties.py +130 -0
- api581_engine-0.1.4/src/api581/api/release.py +252 -0
- api581_engine-0.1.4/src/api581/api/reliability.py +40 -0
- api581_engine-0.1.4/src/api581/api/risk.py +71 -0
- api581_engine-0.1.4/src/api581/api/tank.py +490 -0
- api581_engine-0.1.4/src/api581/api520.py +205 -0
- api581_engine-0.1.4/src/api581/area_contribution.py +72 -0
- api581_engine-0.1.4/src/api581/blast.py +232 -0
- api581_engine-0.1.4/src/api581/brittle.py +205 -0
- api581_engine-0.1.4/src/api581/bundle.py +300 -0
- api581_engine-0.1.4/src/api581/catalog.py +442 -0
- api581_engine-0.1.4/src/api581/caustic_screening.py +103 -0
- api581_engine-0.1.4/src/api581/clad_thinning.py +146 -0
- api581_engine-0.1.4/src/api581/clscc_screening.py +55 -0
- api581_engine-0.1.4/src/api581/co2_corrosion.py +313 -0
- api581_engine-0.1.4/src/api581/co2_screening.py +205 -0
- api581_engine-0.1.4/src/api581/consequences.py +250 -0
- api581_engine-0.1.4/src/api581/contracts.py +1038 -0
- api581_engine-0.1.4/src/api581/cooling_selection.py +204 -0
- api581_engine-0.1.4/src/api581/cooling_water.py +305 -0
- api581_engine-0.1.4/src/api581/core.py +126 -0
- api581_engine-0.1.4/src/api581/corrosion_rate.py +38 -0
- api581_engine-0.1.4/src/api581/cost_tables.py +175 -0
- api581_engine-0.1.4/src/api581/cracking.py +74 -0
- api581_engine-0.1.4/src/api581/data/coverage.json +21361 -0
- api581_engine-0.1.4/src/api581/data/digital-twin.schema.json +538 -0
- api581_engine-0.1.4/src/api581/data/direct-test-queue.json +7 -0
- api581_engine-0.1.4/src/api581/data/native-engine-evidence.json +44 -0
- api581_engine-0.1.4/src/api581/data/python-api.schema.json +92706 -0
- api581_engine-0.1.4/src/api581/data/reference-fixture-evidence.json +2956 -0
- api581_engine-0.1.4/src/api581/data/scope-boundaries.schema.json +58 -0
- api581_engine-0.1.4/src/api581/data/software-test-evidence.json +4278 -0
- api581_engine-0.1.4/src/api581/data/standard-metadata.json +1328 -0
- api581_engine-0.1.4/src/api581/data/standard.schema.json +233 -0
- api581_engine-0.1.4/src/api581/data/supporting-text-review.json +1319 -0
- api581_engine-0.1.4/src/api581/digital_twin.py +491 -0
- api581_engine-0.1.4/src/api581/dispersion.py +45 -0
- api581_engine-0.1.4/src/api581/effects.py +232 -0
- api581_engine-0.1.4/src/api581/evaporation.py +181 -0
- api581_engine-0.1.4/src/api581/evidence.py +81 -0
- api581_engine-0.1.4/src/api581/external_corrosion.py +148 -0
- api581_engine-0.1.4/src/api581/external_cracking.py +63 -0
- api581_engine-0.1.4/src/api581/fatigue.py +56 -0
- api581_engine-0.1.4/src/api581/fireball.py +163 -0
- api581_engine-0.1.4/src/api581/flash_pool.py +111 -0
- api581_engine-0.1.4/src/api581/flash_solver.py +122 -0
- api581_engine-0.1.4/src/api581/groundwater.py +101 -0
- api581_engine-0.1.4/src/api581/h2sh2_corrosion.py +128 -0
- api581_engine-0.1.4/src/api581/hic_screened.py +89 -0
- api581_engine-0.1.4/src/api581/htha.py +45 -0
- api581_engine-0.1.4/src/api581/hydrochloric_acid.py +272 -0
- api581_engine-0.1.4/src/api581/hydrofluoric_acid.py +236 -0
- api581_engine-0.1.4/src/api581/ignition.py +204 -0
- api581_engine-0.1.4/src/api581/inspection_effectiveness.py +601 -0
- api581_engine-0.1.4/src/api581/jet_handoff.py +60 -0
- api581_engine-0.1.4/src/api581/level1.py +311 -0
- api581_engine-0.1.4/src/api581/level1_summary.py +35 -0
- api581_engine-0.1.4/src/api581/level1_toxic.py +313 -0
- api581_engine-0.1.4/src/api581/level1_type1.py +91 -0
- api581_engine-0.1.4/src/api581/level2_summary.py +237 -0
- api581_engine-0.1.4/src/api581/lining.py +173 -0
- api581_engine-0.1.4/src/api581/native_toxic.py +67 -0
- api581_engine-0.1.4/src/api581/outputs.py +5672 -0
- api581_engine-0.1.4/src/api581/oxidation.py +145 -0
- api581_engine-0.1.4/src/api581/pascc_screening.py +78 -0
- api581_engine-0.1.4/src/api581/physical_explosion.py +190 -0
- api581_engine-0.1.4/src/api581/pof.py +207 -0
- api581_engine-0.1.4/src/api581/pool_fire.py +273 -0
- api581_engine-0.1.4/src/api581/portfolio.py +68 -0
- api581_engine-0.1.4/src/api581/prd.py +204 -0
- api581_engine-0.1.4/src/api581/prd_consequences.py +245 -0
- api581_engine-0.1.4/src/api581/prd_history.py +44 -0
- api581_engine-0.1.4/src/api581/py.typed +0 -0
- api581_engine-0.1.4/src/api581/release.py +307 -0
- api581_engine-0.1.4/src/api581/representative_fluids.py +172 -0
- api581_engine-0.1.4/src/api581/result.py +50 -0
- api581_engine-0.1.4/src/api581/risk.py +191 -0
- api581_engine-0.1.4/src/api581/saturation.py +66 -0
- api581_engine-0.1.4/src/api581/scc_mechanisms.py +242 -0
- api581_engine-0.1.4/src/api581/schema.py +45 -0
- api581_engine-0.1.4/src/api581/slabx_adapter.py +261 -0
- api581_engine-0.1.4/src/api581/soil_corrosion.py +191 -0
- api581_engine-0.1.4/src/api581/source_partition.py +169 -0
- api581_engine-0.1.4/src/api581/spatial.py +87 -0
- api581_engine-0.1.4/src/api581/ssc_screening.py +77 -0
- api581_engine-0.1.4/src/api581/standard.py +281 -0
- api581_engine-0.1.4/src/api581/storage.py +42 -0
- api581_engine-0.1.4/src/api581/sulfidic_corrosion.py +197 -0
- api581_engine-0.1.4/src/api581/sulfuric_acid.py +209 -0
- api581_engine-0.1.4/src/api581/tank.py +260 -0
- api581_engine-0.1.4/src/api581/tank_corrosion.py +256 -0
- api581_engine-0.1.4/src/api581/tank_environment.py +186 -0
- api581_engine-0.1.4/src/api581/tank_financial.py +202 -0
- api581_engine-0.1.4/src/api581/tank_integrated.py +51 -0
- api581_engine-0.1.4/src/api581/tank_shell.py +141 -0
- api581_engine-0.1.4/src/api581/tank_source.py +152 -0
- api581_engine-0.1.4/src/api581/tank_thinning.py +204 -0
- api581_engine-0.1.4/src/api581/temper.py +105 -0
- api581_engine-0.1.4/src/api581/thinning.py +172 -0
- api581_engine-0.1.4/src/api581/thinning_conditions.py +212 -0
- api581_engine-0.1.4/src/api581/thinning_history.py +118 -0
- api581_engine-0.1.4/src/api581/thinning_selection.py +81 -0
- api581_engine-0.1.4/src/api581/thinning_type.py +34 -0
- api581_engine-0.1.4/src/api581/toxic_criteria.py +111 -0
- api581_engine-0.1.4/src/api581/toxic_level2.py +233 -0
- api581_engine-0.1.4/src/api581/two_phase_events.py +120 -0
- api581_engine-0.1.4/src/api581/workflow.py +42 -0
- api581_engine-0.1.4/src/api581_engine.egg-info/PKG-INFO +419 -0
- api581_engine-0.1.4/src/api581_engine.egg-info/SOURCES.txt +267 -0
- api581_engine-0.1.4/src/api581_engine.egg-info/dependency_links.txt +1 -0
- api581_engine-0.1.4/src/api581_engine.egg-info/requires.txt +22 -0
- api581_engine-0.1.4/src/api581_engine.egg-info/top_level.txt +1 -0
- api581_engine-0.1.4/tests/test_acid_sour_water.py +161 -0
- api581_engine-0.1.4/tests/test_acscc_qualified.py +39 -0
- api581_engine-0.1.4/tests/test_acscc_screening.py +27 -0
- api581_engine-0.1.4/tests/test_acscc_water.py +36 -0
- api581_engine-0.1.4/tests/test_additional.py +123 -0
- api581_engine-0.1.4/tests/test_alkaline_sour_water.py +184 -0
- api581_engine-0.1.4/tests/test_amine_corrosion.py +205 -0
- api581_engine-0.1.4/tests/test_amine_figure.py +78 -0
- api581_engine-0.1.4/tests/test_amine_screening.py +51 -0
- api581_engine-0.1.4/tests/test_api520.py +71 -0
- api581_engine-0.1.4/tests/test_api520_public_boundaries.py +23 -0
- api581_engine-0.1.4/tests/test_area_contribution.py +57 -0
- api581_engine-0.1.4/tests/test_blast.py +177 -0
- api581_engine-0.1.4/tests/test_brittle.py +176 -0
- api581_engine-0.1.4/tests/test_bundle.py +193 -0
- api581_engine-0.1.4/tests/test_calculations.py +214 -0
- api581_engine-0.1.4/tests/test_catalog.py +230 -0
- api581_engine-0.1.4/tests/test_caustic_screening.py +105 -0
- api581_engine-0.1.4/tests/test_clad_thinning.py +167 -0
- api581_engine-0.1.4/tests/test_clscc_qualified.py +53 -0
- api581_engine-0.1.4/tests/test_clscc_screening.py +56 -0
- api581_engine-0.1.4/tests/test_co2_corrosion.py +178 -0
- api581_engine-0.1.4/tests/test_co2_screening.py +164 -0
- api581_engine-0.1.4/tests/test_consequences.py +92 -0
- api581_engine-0.1.4/tests/test_cooling_selection.py +166 -0
- api581_engine-0.1.4/tests/test_cooling_water.py +195 -0
- api581_engine-0.1.4/tests/test_corrosion_rate.py +53 -0
- api581_engine-0.1.4/tests/test_cost_tables.py +76 -0
- api581_engine-0.1.4/tests/test_custom_thinning_prior.py +59 -0
- api581_engine-0.1.4/tests/test_damage_chemistry_public.py +22 -0
- api581_engine-0.1.4/tests/test_damage_composed_public_boundaries.py +48 -0
- api581_engine-0.1.4/tests/test_damage_mechanism_composed_public.py +22 -0
- api581_engine-0.1.4/tests/test_damage_rate_primitives_public.py +42 -0
- api581_engine-0.1.4/tests/test_damage_scc_qualified_public.py +276 -0
- api581_engine-0.1.4/tests/test_damage_screening_assessments_public.py +20 -0
- api581_engine-0.1.4/tests/test_damage_screening_public.py +24 -0
- api581_engine-0.1.4/tests/test_damage_screening_public_boundaries.py +29 -0
- api581_engine-0.1.4/tests/test_damage_selection_composed_public.py +41 -0
- api581_engine-0.1.4/tests/test_damage_selection_public.py +20 -0
- api581_engine-0.1.4/tests/test_damage_table_public.py +20 -0
- api581_engine-0.1.4/tests/test_damage_thinning_public_boundaries.py +40 -0
- api581_engine-0.1.4/tests/test_detection_isolation.py +89 -0
- api581_engine-0.1.4/tests/test_digital_twin_contract.py +291 -0
- api581_engine-0.1.4/tests/test_direct_test_queue.py +16 -0
- api581_engine-0.1.4/tests/test_dispersion_grid_public.py +19 -0
- api581_engine-0.1.4/tests/test_dispersion_public_boundaries.py +48 -0
- api581_engine-0.1.4/tests/test_evaporation.py +177 -0
- api581_engine-0.1.4/tests/test_events_prd_public_primitives.py +58 -0
- api581_engine-0.1.4/tests/test_examples.py +20 -0
- api581_engine-0.1.4/tests/test_external_corrosion.py +90 -0
- api581_engine-0.1.4/tests/test_financial_hole.py +37 -0
- api581_engine-0.1.4/tests/test_fireball.py +165 -0
- api581_engine-0.1.4/tests/test_flash_pool.py +20 -0
- api581_engine-0.1.4/tests/test_flash_solver.py +54 -0
- api581_engine-0.1.4/tests/test_flashed_pool_flash_fire.py +22 -0
- api581_engine-0.1.4/tests/test_frequency_method_selection.py +19 -0
- api581_engine-0.1.4/tests/test_groundwater.py +98 -0
- api581_engine-0.1.4/tests/test_h2sh2_corrosion.py +113 -0
- api581_engine-0.1.4/tests/test_hic_h2s_screening.py +19 -0
- api581_engine-0.1.4/tests/test_hic_qualified.py +78 -0
- api581_engine-0.1.4/tests/test_hydrochloric_acid.py +187 -0
- api581_engine-0.1.4/tests/test_hydrofluoric_acid.py +173 -0
- api581_engine-0.1.4/tests/test_hydrogen_partial_pressure.py +10 -0
- api581_engine-0.1.4/tests/test_ignition.py +153 -0
- api581_engine-0.1.4/tests/test_inspection_effectiveness.py +302 -0
- api581_engine-0.1.4/tests/test_inspection_effectiveness_primitives.py +165 -0
- api581_engine-0.1.4/tests/test_inspection_effectiveness_summary.py +19 -0
- api581_engine-0.1.4/tests/test_inventory_ancestors.py +67 -0
- api581_engine-0.1.4/tests/test_level1.py +95 -0
- api581_engine-0.1.4/tests/test_level1_toxic.py +144 -0
- api581_engine-0.1.4/tests/test_level2_summary.py +215 -0
- api581_engine-0.1.4/tests/test_lining.py +168 -0
- api581_engine-0.1.4/tests/test_native_jet.py +83 -0
- api581_engine-0.1.4/tests/test_native_jet_documentation.py +15 -0
- api581_engine-0.1.4/tests/test_nurion_payload.py +15 -0
- api581_engine-0.1.4/tests/test_nurion_reconcile.py +33 -0
- api581_engine-0.1.4/tests/test_nurion_submit_profile.py +29 -0
- api581_engine-0.1.4/tests/test_oxidation.py +128 -0
- api581_engine-0.1.4/tests/test_pascc_figure.py +75 -0
- api581_engine-0.1.4/tests/test_pascc_screening.py +17 -0
- api581_engine-0.1.4/tests/test_physical_explosion.py +210 -0
- api581_engine-0.1.4/tests/test_pof_method_selection.py +37 -0
- api581_engine-0.1.4/tests/test_pool_fire.py +220 -0
- api581_engine-0.1.4/tests/test_prd.py +162 -0
- api581_engine-0.1.4/tests/test_prd_consequences.py +165 -0
- api581_engine-0.1.4/tests/test_prd_history.py +62 -0
- api581_engine-0.1.4/tests/test_python_api.py +1442 -0
- api581_engine-0.1.4/tests/test_registry_contract.py +34 -0
- api581_engine-0.1.4/tests/test_representative_fluids.py +246 -0
- api581_engine-0.1.4/tests/test_risk_assessment_from_damage.py +44 -0
- api581_engine-0.1.4/tests/test_saturation.py +21 -0
- api581_engine-0.1.4/tests/test_scc_mechanisms.py +104 -0
- api581_engine-0.1.4/tests/test_slabx_adapter.py +125 -0
- api581_engine-0.1.4/tests/test_soil_corrosion.py +134 -0
- api581_engine-0.1.4/tests/test_source_partition.py +150 -0
- api581_engine-0.1.4/tests/test_spatial.py +79 -0
- api581_engine-0.1.4/tests/test_ssc_qualified.py +85 -0
- api581_engine-0.1.4/tests/test_ssc_screening.py +20 -0
- api581_engine-0.1.4/tests/test_standard.py +73 -0
- api581_engine-0.1.4/tests/test_sulfidic_corrosion.py +164 -0
- api581_engine-0.1.4/tests/test_sulfuric_acid.py +174 -0
- api581_engine-0.1.4/tests/test_supporting_text_dispositions.py +20 -0
- api581_engine-0.1.4/tests/test_supporting_text_review.py +52 -0
- api581_engine-0.1.4/tests/test_tank_composed_public.py +38 -0
- api581_engine-0.1.4/tests/test_tank_consequence_public.py +17 -0
- api581_engine-0.1.4/tests/test_tank_corrosion.py +167 -0
- api581_engine-0.1.4/tests/test_tank_corrosion_factor_public.py +28 -0
- api581_engine-0.1.4/tests/test_tank_environment.py +134 -0
- api581_engine-0.1.4/tests/test_tank_environment_public.py +21 -0
- api581_engine-0.1.4/tests/test_tank_financial.py +205 -0
- api581_engine-0.1.4/tests/test_tank_financial_public_boundaries.py +36 -0
- api581_engine-0.1.4/tests/test_tank_public_primitives.py +39 -0
- api581_engine-0.1.4/tests/test_tank_remaining_public_boundaries.py +31 -0
- api581_engine-0.1.4/tests/test_tank_shell.py +172 -0
- api581_engine-0.1.4/tests/test_tank_source_composition.py +150 -0
- api581_engine-0.1.4/tests/test_tank_sources.py +160 -0
- api581_engine-0.1.4/tests/test_tank_thinning.py +186 -0
- api581_engine-0.1.4/tests/test_temper.py +89 -0
- api581_engine-0.1.4/tests/test_thinning_conditions.py +156 -0
- api581_engine-0.1.4/tests/test_thinning_history.py +93 -0
- api581_engine-0.1.4/tests/test_thinning_selection.py +65 -0
- api581_engine-0.1.4/tests/test_toxic_criteria.py +134 -0
- api581_engine-0.1.4/tests/test_toxic_level2.py +187 -0
- api581_engine-0.1.4/tests/test_two_phase_events.py +182 -0
- api581_engine-0.1.4/tests/test_type1.py +76 -0
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction, and
|
|
10
|
+
distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by the
|
|
13
|
+
copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all other
|
|
16
|
+
entities that control, are controlled by, or are under common control with
|
|
17
|
+
that entity. For the purposes of this definition, "control" means (i) the
|
|
18
|
+
power, direct or indirect, to cause the direction or management of such
|
|
19
|
+
entity, whether by contract or otherwise, or (ii) ownership of fifty
|
|
20
|
+
percent (50%) or more of the outstanding shares, or (iii) beneficial
|
|
21
|
+
ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity exercising
|
|
24
|
+
permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation source,
|
|
28
|
+
and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical transformation
|
|
31
|
+
or translation of a Source form, including but not limited to compiled
|
|
32
|
+
object code, generated documentation, and conversions to other media types.
|
|
33
|
+
|
|
34
|
+
"Work" shall mean the work of authorship, whether in Source or Object form,
|
|
35
|
+
made available under the License, as indicated by a copyright notice that
|
|
36
|
+
is included in or attached to the work (an example is provided in the
|
|
37
|
+
Appendix below).
|
|
38
|
+
|
|
39
|
+
"Derivative Works" shall mean any work, whether in Source or Object form,
|
|
40
|
+
that is based on (or derived from) the Work and for which the editorial
|
|
41
|
+
revisions, annotations, elaborations, or other modifications represent, as
|
|
42
|
+
a whole, an original work of authorship. For the purposes of this License,
|
|
43
|
+
Derivative Works shall not include works that remain separable from, or
|
|
44
|
+
merely link (or bind by name) to the interfaces of, the Work and Derivative
|
|
45
|
+
Works thereof.
|
|
46
|
+
|
|
47
|
+
"Contribution" shall mean any work of authorship, including the original
|
|
48
|
+
version of the Work and any modifications or additions to that Work or
|
|
49
|
+
Derivative Works thereof, that is intentionally submitted to Licensor for
|
|
50
|
+
inclusion in the Work by the copyright owner or by an individual or Legal
|
|
51
|
+
Entity authorized to submit on behalf of the copyright owner. For the
|
|
52
|
+
purposes of this definition, "submitted" means any form of electronic,
|
|
53
|
+
verbal, or written communication sent to the Licensor or its
|
|
54
|
+
representatives, including but not limited to communication on electronic
|
|
55
|
+
mailing lists, source code control systems, and issue tracking systems that
|
|
56
|
+
are managed by, or on behalf of, the Licensor for the purpose of discussing
|
|
57
|
+
and improving the Work, but excluding communication that is conspicuously
|
|
58
|
+
marked or otherwise designated in writing by the copyright owner as "Not a
|
|
59
|
+
Contribution."
|
|
60
|
+
|
|
61
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity on
|
|
62
|
+
behalf of whom a Contribution has been received by Licensor and
|
|
63
|
+
subsequently incorporated within the Work.
|
|
64
|
+
|
|
65
|
+
2. Grant of Copyright License. Subject to the terms and conditions of this
|
|
66
|
+
License, each Contributor hereby grants to You a perpetual, worldwide,
|
|
67
|
+
non-exclusive, no-charge, royalty-free, irrevocable copyright license to
|
|
68
|
+
reproduce, prepare Derivative Works of, publicly display, publicly perform,
|
|
69
|
+
sublicense, and distribute the Work and such Derivative Works in Source or
|
|
70
|
+
Object form.
|
|
71
|
+
|
|
72
|
+
3. Grant of Patent License. Subject to the terms and conditions of this
|
|
73
|
+
License, each Contributor hereby grants to You a perpetual, worldwide,
|
|
74
|
+
non-exclusive, no-charge, royalty-free, irrevocable (except as stated in
|
|
75
|
+
this section) patent license to make, have made, use, offer to sell, sell,
|
|
76
|
+
import, and otherwise transfer the Work, where such license applies only to
|
|
77
|
+
those patent claims licensable by such Contributor that are necessarily
|
|
78
|
+
infringed by their Contribution(s) alone or by combination of their
|
|
79
|
+
Contribution(s) with the Work to which such Contribution(s) was submitted.
|
|
80
|
+
|
|
81
|
+
4. Redistribution. You may reproduce and distribute copies of the Work or
|
|
82
|
+
Derivative Works thereof in any medium, with or without modifications, and
|
|
83
|
+
in Source or Object form, provided that You meet the following conditions:
|
|
84
|
+
|
|
85
|
+
(a) You must give any other recipients of the Work or Derivative Works a
|
|
86
|
+
copy of this License; and
|
|
87
|
+
|
|
88
|
+
(b) You must cause any modified files to carry prominent notices stating
|
|
89
|
+
that You changed the files; and
|
|
90
|
+
|
|
91
|
+
(c) You must retain, in the Source form of any Derivative Works that You
|
|
92
|
+
distribute, all copyright, patent, trademark, and attribution notices
|
|
93
|
+
from the Source form of the Work, excluding those notices that do not
|
|
94
|
+
pertain to any part of the Derivative Works; and
|
|
95
|
+
|
|
96
|
+
(d) If the Work includes a "NOTICE" text file as part of its distribution,
|
|
97
|
+
then any Derivative Works that You distribute must include a readable
|
|
98
|
+
copy of the attribution notices contained within such NOTICE file,
|
|
99
|
+
excluding those notices that do not pertain to any part of the
|
|
100
|
+
Derivative Works, in at least one of the following places: within a
|
|
101
|
+
NOTICE text file distributed as part of the Derivative Works; within
|
|
102
|
+
the Source form or documentation, if provided along with the
|
|
103
|
+
Derivative Works; or, within a display generated by the Derivative
|
|
104
|
+
Works, if and wherever such third-party notices normally appear. The
|
|
105
|
+
contents of the NOTICE file are for informational purposes only and do
|
|
106
|
+
not modify the License. You may add Your own attribution notices within
|
|
107
|
+
Derivative Works that You distribute, alongside or as an addendum to
|
|
108
|
+
the NOTICE text from the Work, provided that such additional
|
|
109
|
+
attribution notices cannot be construed as modifying the License.
|
|
110
|
+
|
|
111
|
+
You may add Your own copyright statement to Your modifications and may
|
|
112
|
+
provide additional or different license terms and conditions for use,
|
|
113
|
+
reproduction, or distribution of Your modifications, or for any such
|
|
114
|
+
Derivative Works as a whole, provided Your use, reproduction, and
|
|
115
|
+
distribution of the Work otherwise complies with the conditions stated in
|
|
116
|
+
this License.
|
|
117
|
+
|
|
118
|
+
5. Submission of Contributions. Unless You explicitly state otherwise, any
|
|
119
|
+
Contribution intentionally submitted for inclusion in the Work by You to
|
|
120
|
+
the Licensor shall be under the terms and conditions of this License,
|
|
121
|
+
without any additional terms or conditions. Notwithstanding the above,
|
|
122
|
+
nothing herein shall supersede or modify the terms of any separate license
|
|
123
|
+
agreement you may have executed with Licensor regarding such Contributions.
|
|
124
|
+
|
|
125
|
+
6. Trademarks. This License does not grant permission to use the trade names,
|
|
126
|
+
trademarks, service marks, or product names of the Licensor, except as
|
|
127
|
+
required for reasonable and customary use in describing the origin of the
|
|
128
|
+
Work and reproducing the content of the NOTICE file.
|
|
129
|
+
|
|
130
|
+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
|
|
131
|
+
writing, Licensor provides the Work (and each Contributor provides its
|
|
132
|
+
Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
|
|
133
|
+
ANY KIND, either express or implied, including, without limitation, any
|
|
134
|
+
warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
|
|
135
|
+
FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
|
|
136
|
+
determining the appropriateness of using or redistributing the Work and
|
|
137
|
+
assume any risks associated with Your exercise of permissions under this
|
|
138
|
+
License.
|
|
139
|
+
|
|
140
|
+
8. Limitation of Liability. In no event and under no legal theory, whether in
|
|
141
|
+
tort (including negligence), contract, or otherwise, unless required by
|
|
142
|
+
applicable law (such as deliberate and grossly negligent acts) or agreed to
|
|
143
|
+
in writing, shall any Contributor be liable to You for damages, including
|
|
144
|
+
any direct, indirect, special, incidental, or consequential damages of any
|
|
145
|
+
character arising as a result of this License or out of the use or
|
|
146
|
+
inability to use the Work (including but not limited to damages for loss of
|
|
147
|
+
goodwill, work stoppage, computer failure or malfunction, or any and all
|
|
148
|
+
other commercial damages or losses), even if such Contributor has been
|
|
149
|
+
advised of the possibility of such damages.
|
|
150
|
+
|
|
151
|
+
9. Accepting Warranty or Additional Liability. While redistributing the Work
|
|
152
|
+
or Derivative Works thereof, You may choose to offer, and charge a fee for,
|
|
153
|
+
acceptance of support, warranty, indemnity, or other liability obligations
|
|
154
|
+
and/or rights consistent with this License. However, in accepting such
|
|
155
|
+
obligations, You may act only on Your own behalf and on Your sole
|
|
156
|
+
responsibility, not on behalf of any other Contributor, and only if You
|
|
157
|
+
agree to indemnify, defend, and hold each Contributor harmless for any
|
|
158
|
+
liability incurred by, or claims asserted against, such Contributor by
|
|
159
|
+
reason of your accepting any such warranty or additional liability.
|
|
160
|
+
|
|
161
|
+
END OF TERMS AND CONDITIONS
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Notice and distribution boundary
|
|
2
|
+
|
|
3
|
+
`API RP 581 Risk Analysis Module` is an unofficial, independently authored
|
|
4
|
+
Python implementation. API, API RP 581, and related marks belong to their
|
|
5
|
+
respective owners. This project is not affiliated with, endorsed by, or
|
|
6
|
+
certified by the American Petroleum Institute.
|
|
7
|
+
|
|
8
|
+
The public repository and Python distributions contain original source code,
|
|
9
|
+
original documentation, generated schemas, hashes, and test evidence. They do
|
|
10
|
+
not redistribute API standards, purchased PDFs, DOCX files, proprietary
|
|
11
|
+
tables, or copied standard text. Local source documents used to build or audit
|
|
12
|
+
the project are excluded by `.gitignore` and are not covered by the Apache-2.0
|
|
13
|
+
license in this repository.
|
|
14
|
+
|
|
15
|
+
Numerical values derived from public worked examples or standards are retained
|
|
16
|
+
only as implementation inputs, fixtures, or traceability metadata; the
|
|
17
|
+
original publications remain the authoritative source. Users must obtain and
|
|
18
|
+
use standards under their own license and verify suitability for their assets.
|
|
@@ -0,0 +1,419 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: api581-engine
|
|
3
|
+
Version: 0.1.4
|
|
4
|
+
Summary: API RP 581 Risk Analysis Module: composable Python calculations and workflows
|
|
5
|
+
License: Apache License
|
|
6
|
+
Version 2.0, January 2004
|
|
7
|
+
http://www.apache.org/licenses/
|
|
8
|
+
|
|
9
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
10
|
+
|
|
11
|
+
1. Definitions.
|
|
12
|
+
|
|
13
|
+
"License" shall mean the terms and conditions for use, reproduction, and
|
|
14
|
+
distribution as defined by Sections 1 through 9 of this document.
|
|
15
|
+
|
|
16
|
+
"Licensor" shall mean the copyright owner or entity authorized by the
|
|
17
|
+
copyright owner that is granting the License.
|
|
18
|
+
|
|
19
|
+
"Legal Entity" shall mean the union of the acting entity and all other
|
|
20
|
+
entities that control, are controlled by, or are under common control with
|
|
21
|
+
that entity. For the purposes of this definition, "control" means (i) the
|
|
22
|
+
power, direct or indirect, to cause the direction or management of such
|
|
23
|
+
entity, whether by contract or otherwise, or (ii) ownership of fifty
|
|
24
|
+
percent (50%) or more of the outstanding shares, or (iii) beneficial
|
|
25
|
+
ownership of such entity.
|
|
26
|
+
|
|
27
|
+
"You" (or "Your") shall mean an individual or Legal Entity exercising
|
|
28
|
+
permissions granted by this License.
|
|
29
|
+
|
|
30
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
31
|
+
including but not limited to software source code, documentation source,
|
|
32
|
+
and configuration files.
|
|
33
|
+
|
|
34
|
+
"Object" form shall mean any form resulting from mechanical transformation
|
|
35
|
+
or translation of a Source form, including but not limited to compiled
|
|
36
|
+
object code, generated documentation, and conversions to other media types.
|
|
37
|
+
|
|
38
|
+
"Work" shall mean the work of authorship, whether in Source or Object form,
|
|
39
|
+
made available under the License, as indicated by a copyright notice that
|
|
40
|
+
is included in or attached to the work (an example is provided in the
|
|
41
|
+
Appendix below).
|
|
42
|
+
|
|
43
|
+
"Derivative Works" shall mean any work, whether in Source or Object form,
|
|
44
|
+
that is based on (or derived from) the Work and for which the editorial
|
|
45
|
+
revisions, annotations, elaborations, or other modifications represent, as
|
|
46
|
+
a whole, an original work of authorship. For the purposes of this License,
|
|
47
|
+
Derivative Works shall not include works that remain separable from, or
|
|
48
|
+
merely link (or bind by name) to the interfaces of, the Work and Derivative
|
|
49
|
+
Works thereof.
|
|
50
|
+
|
|
51
|
+
"Contribution" shall mean any work of authorship, including the original
|
|
52
|
+
version of the Work and any modifications or additions to that Work or
|
|
53
|
+
Derivative Works thereof, that is intentionally submitted to Licensor for
|
|
54
|
+
inclusion in the Work by the copyright owner or by an individual or Legal
|
|
55
|
+
Entity authorized to submit on behalf of the copyright owner. For the
|
|
56
|
+
purposes of this definition, "submitted" means any form of electronic,
|
|
57
|
+
verbal, or written communication sent to the Licensor or its
|
|
58
|
+
representatives, including but not limited to communication on electronic
|
|
59
|
+
mailing lists, source code control systems, and issue tracking systems that
|
|
60
|
+
are managed by, or on behalf of, the Licensor for the purpose of discussing
|
|
61
|
+
and improving the Work, but excluding communication that is conspicuously
|
|
62
|
+
marked or otherwise designated in writing by the copyright owner as "Not a
|
|
63
|
+
Contribution."
|
|
64
|
+
|
|
65
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity on
|
|
66
|
+
behalf of whom a Contribution has been received by Licensor and
|
|
67
|
+
subsequently incorporated within the Work.
|
|
68
|
+
|
|
69
|
+
2. Grant of Copyright License. Subject to the terms and conditions of this
|
|
70
|
+
License, each Contributor hereby grants to You a perpetual, worldwide,
|
|
71
|
+
non-exclusive, no-charge, royalty-free, irrevocable copyright license to
|
|
72
|
+
reproduce, prepare Derivative Works of, publicly display, publicly perform,
|
|
73
|
+
sublicense, and distribute the Work and such Derivative Works in Source or
|
|
74
|
+
Object form.
|
|
75
|
+
|
|
76
|
+
3. Grant of Patent License. Subject to the terms and conditions of this
|
|
77
|
+
License, each Contributor hereby grants to You a perpetual, worldwide,
|
|
78
|
+
non-exclusive, no-charge, royalty-free, irrevocable (except as stated in
|
|
79
|
+
this section) patent license to make, have made, use, offer to sell, sell,
|
|
80
|
+
import, and otherwise transfer the Work, where such license applies only to
|
|
81
|
+
those patent claims licensable by such Contributor that are necessarily
|
|
82
|
+
infringed by their Contribution(s) alone or by combination of their
|
|
83
|
+
Contribution(s) with the Work to which such Contribution(s) was submitted.
|
|
84
|
+
|
|
85
|
+
4. Redistribution. You may reproduce and distribute copies of the Work or
|
|
86
|
+
Derivative Works thereof in any medium, with or without modifications, and
|
|
87
|
+
in Source or Object form, provided that You meet the following conditions:
|
|
88
|
+
|
|
89
|
+
(a) You must give any other recipients of the Work or Derivative Works a
|
|
90
|
+
copy of this License; and
|
|
91
|
+
|
|
92
|
+
(b) You must cause any modified files to carry prominent notices stating
|
|
93
|
+
that You changed the files; and
|
|
94
|
+
|
|
95
|
+
(c) You must retain, in the Source form of any Derivative Works that You
|
|
96
|
+
distribute, all copyright, patent, trademark, and attribution notices
|
|
97
|
+
from the Source form of the Work, excluding those notices that do not
|
|
98
|
+
pertain to any part of the Derivative Works; and
|
|
99
|
+
|
|
100
|
+
(d) If the Work includes a "NOTICE" text file as part of its distribution,
|
|
101
|
+
then any Derivative Works that You distribute must include a readable
|
|
102
|
+
copy of the attribution notices contained within such NOTICE file,
|
|
103
|
+
excluding those notices that do not pertain to any part of the
|
|
104
|
+
Derivative Works, in at least one of the following places: within a
|
|
105
|
+
NOTICE text file distributed as part of the Derivative Works; within
|
|
106
|
+
the Source form or documentation, if provided along with the
|
|
107
|
+
Derivative Works; or, within a display generated by the Derivative
|
|
108
|
+
Works, if and wherever such third-party notices normally appear. The
|
|
109
|
+
contents of the NOTICE file are for informational purposes only and do
|
|
110
|
+
not modify the License. You may add Your own attribution notices within
|
|
111
|
+
Derivative Works that You distribute, alongside or as an addendum to
|
|
112
|
+
the NOTICE text from the Work, provided that such additional
|
|
113
|
+
attribution notices cannot be construed as modifying the License.
|
|
114
|
+
|
|
115
|
+
You may add Your own copyright statement to Your modifications and may
|
|
116
|
+
provide additional or different license terms and conditions for use,
|
|
117
|
+
reproduction, or distribution of Your modifications, or for any such
|
|
118
|
+
Derivative Works as a whole, provided Your use, reproduction, and
|
|
119
|
+
distribution of the Work otherwise complies with the conditions stated in
|
|
120
|
+
this License.
|
|
121
|
+
|
|
122
|
+
5. Submission of Contributions. Unless You explicitly state otherwise, any
|
|
123
|
+
Contribution intentionally submitted for inclusion in the Work by You to
|
|
124
|
+
the Licensor shall be under the terms and conditions of this License,
|
|
125
|
+
without any additional terms or conditions. Notwithstanding the above,
|
|
126
|
+
nothing herein shall supersede or modify the terms of any separate license
|
|
127
|
+
agreement you may have executed with Licensor regarding such Contributions.
|
|
128
|
+
|
|
129
|
+
6. Trademarks. This License does not grant permission to use the trade names,
|
|
130
|
+
trademarks, service marks, or product names of the Licensor, except as
|
|
131
|
+
required for reasonable and customary use in describing the origin of the
|
|
132
|
+
Work and reproducing the content of the NOTICE file.
|
|
133
|
+
|
|
134
|
+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
|
|
135
|
+
writing, Licensor provides the Work (and each Contributor provides its
|
|
136
|
+
Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
|
|
137
|
+
ANY KIND, either express or implied, including, without limitation, any
|
|
138
|
+
warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
|
|
139
|
+
FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
|
|
140
|
+
determining the appropriateness of using or redistributing the Work and
|
|
141
|
+
assume any risks associated with Your exercise of permissions under this
|
|
142
|
+
License.
|
|
143
|
+
|
|
144
|
+
8. Limitation of Liability. In no event and under no legal theory, whether in
|
|
145
|
+
tort (including negligence), contract, or otherwise, unless required by
|
|
146
|
+
applicable law (such as deliberate and grossly negligent acts) or agreed to
|
|
147
|
+
in writing, shall any Contributor be liable to You for damages, including
|
|
148
|
+
any direct, indirect, special, incidental, or consequential damages of any
|
|
149
|
+
character arising as a result of this License or out of the use or
|
|
150
|
+
inability to use the Work (including but not limited to damages for loss of
|
|
151
|
+
goodwill, work stoppage, computer failure or malfunction, or any and all
|
|
152
|
+
other commercial damages or losses), even if such Contributor has been
|
|
153
|
+
advised of the possibility of such damages.
|
|
154
|
+
|
|
155
|
+
9. Accepting Warranty or Additional Liability. While redistributing the Work
|
|
156
|
+
or Derivative Works thereof, You may choose to offer, and charge a fee for,
|
|
157
|
+
acceptance of support, warranty, indemnity, or other liability obligations
|
|
158
|
+
and/or rights consistent with this License. However, in accepting such
|
|
159
|
+
obligations, You may act only on Your own behalf and on Your sole
|
|
160
|
+
responsibility, not on behalf of any other Contributor, and only if You
|
|
161
|
+
agree to indemnify, defend, and hold each Contributor harmless for any
|
|
162
|
+
liability incurred by, or claims asserted against, such Contributor by
|
|
163
|
+
reason of your accepting any such warranty or additional liability.
|
|
164
|
+
|
|
165
|
+
END OF TERMS AND CONDITIONS
|
|
166
|
+
|
|
167
|
+
Keywords: api-581,risk-based-inspection,rbi,asset-integrity,process-safety
|
|
168
|
+
Classifier: Development Status :: 4 - Beta
|
|
169
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
170
|
+
Classifier: Programming Language :: Python :: 3
|
|
171
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
172
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
173
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
174
|
+
Classifier: Topic :: Scientific/Engineering
|
|
175
|
+
Requires-Python: >=3.12
|
|
176
|
+
Description-Content-Type: text/markdown
|
|
177
|
+
License-File: LICENSE
|
|
178
|
+
License-File: NOTICE.md
|
|
179
|
+
Requires-Dist: pydantic<3,>=2.9
|
|
180
|
+
Provides-Extra: test
|
|
181
|
+
Requires-Dist: pytest<10,>=8; extra == "test"
|
|
182
|
+
Provides-Extra: source
|
|
183
|
+
Requires-Dist: pypdf<7,>=5; extra == "source"
|
|
184
|
+
Provides-Extra: flash
|
|
185
|
+
Requires-Dist: CoolProp==8.0.0; extra == "flash"
|
|
186
|
+
Provides-Extra: slabx
|
|
187
|
+
Requires-Dist: slabx==1.0.8; extra == "slabx"
|
|
188
|
+
Provides-Extra: slabx-lh2
|
|
189
|
+
Requires-Dist: slabx==1.0.8; extra == "slabx-lh2"
|
|
190
|
+
Requires-Dist: slabx-lh2==0.2.0; extra == "slabx-lh2"
|
|
191
|
+
Provides-Extra: hpc-sqlite
|
|
192
|
+
Requires-Dist: pysqlite3-binary==0.5.4.post2; platform_system == "Linux" and extra == "hpc-sqlite"
|
|
193
|
+
Dynamic: license-file
|
|
194
|
+
|
|
195
|
+
# API RP 581 Risk Analysis Module
|
|
196
|
+
|
|
197
|
+
An unofficial, independently authored Python implementation of API-RP-581
|
|
198
|
+
risk-based inspection calculations and composable risk workflows.
|
|
199
|
+
|
|
200
|
+
> **Important legal and engineering notice**
|
|
201
|
+
>
|
|
202
|
+
> This project is not affiliated with or endorsed by the American Petroleum
|
|
203
|
+
> Institute. `API`, `API RP 581`, and related marks belong to their respective
|
|
204
|
+
> owners. The repository does not redistribute API standards or purchased
|
|
205
|
+
> source documents. Obtain the applicable standard under your own license.
|
|
206
|
+
> Results are software calculations, not a fitness-for-service decision,
|
|
207
|
+
> inspection release, operating authorization, or safety certification.
|
|
208
|
+
> Applicability, input quality, engineering assumptions, and site acceptance
|
|
209
|
+
> remain the user's responsibility.
|
|
210
|
+
|
|
211
|
+
## What this package provides
|
|
212
|
+
|
|
213
|
+
The package is published as `api581-engine` and imported as `api581`.
|
|
214
|
+
The project display name is **API RP 581 Risk Analysis Module**.
|
|
215
|
+
|
|
216
|
+
- 509 typed calculation registrations with Pydantic input/output contracts
|
|
217
|
+
- 861 API-RP-581 source-section records with section → calculation → test
|
|
218
|
+
traceability
|
|
219
|
+
- Individual calculations and composable integrated workflows
|
|
220
|
+
- Level 1/Level 2 consequence and risk composition boundaries
|
|
221
|
+
- Four representative release-hole paths, effects, financial consequence,
|
|
222
|
+
probability/frequency and portfolio aggregation APIs
|
|
223
|
+
- Optional SLABx 1.0.8 and SLABx-LH2 0.2.0 process-isolated adapters
|
|
224
|
+
- API 520 capacity-sizing utilities kept as a clearly separated companion
|
|
225
|
+
namespace
|
|
226
|
+
- Digital-twin schemas, catalog queries, validation evidence and JSON receipts
|
|
227
|
+
- Reproducible local and Nurion PBS verification scripts
|
|
228
|
+
|
|
229
|
+
The current release is software-verified with external evaluation explicitly
|
|
230
|
+
out of project scope. It is not a third-party API conformity certificate.
|
|
231
|
+
|
|
232
|
+
## Install
|
|
233
|
+
|
|
234
|
+
```bash
|
|
235
|
+
python -m pip install api581-engine
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
For development and the full test suite:
|
|
239
|
+
|
|
240
|
+
```bash
|
|
241
|
+
python -m pip install -e ".[test]"
|
|
242
|
+
python -m pytest -q
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
Optional capabilities:
|
|
246
|
+
|
|
247
|
+
```bash
|
|
248
|
+
python -m pip install -e ".[source]" # read local PDF source metadata
|
|
249
|
+
python -m pip install -e ".[flash]" # CoolProp pure-fluid routes
|
|
250
|
+
python -m pip install -e ".[slabx]" # SLABx 1.0.8 adapter
|
|
251
|
+
python -m pip install -e ".[slabx-lh2]" # SLABx-LH2 0.2.0 boundary
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
The optional native packages are never silently replaced by an alternate
|
|
255
|
+
engine. Missing packages produce an explicit capability status or a typed
|
|
256
|
+
optional-engine error.
|
|
257
|
+
|
|
258
|
+
## Quick start
|
|
259
|
+
|
|
260
|
+
Every public calculation has a typed `*Input` model and a typed result. The
|
|
261
|
+
registry, schemas and catalog are available without learning internal module
|
|
262
|
+
layout.
|
|
263
|
+
|
|
264
|
+
```python
|
|
265
|
+
from api581 import Context
|
|
266
|
+
from api581.api import release
|
|
267
|
+
|
|
268
|
+
result = release.gas(
|
|
269
|
+
release.GasInput(
|
|
270
|
+
diameter_m=0.0254,
|
|
271
|
+
upstream_pressure_pa_abs=1_000_000,
|
|
272
|
+
temperature_k=300,
|
|
273
|
+
molecular_weight_kg_kmol=23,
|
|
274
|
+
heat_capacity_ratio=1.3,
|
|
275
|
+
),
|
|
276
|
+
context=Context(asset_id="pipe-001"),
|
|
277
|
+
)
|
|
278
|
+
|
|
279
|
+
print(result.outputs.mass_rate_kg_s)
|
|
280
|
+
print(result.references)
|
|
281
|
+
print(result.limitations)
|
|
282
|
+
print(result.validation_evidence)
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
For a discoverable interface:
|
|
286
|
+
|
|
287
|
+
```python
|
|
288
|
+
from api581 import calculation_catalog, calculation_evidence
|
|
289
|
+
|
|
290
|
+
for item in calculation_catalog(domain="risk"):
|
|
291
|
+
print(item.calculation_id, item.title, item.python_path)
|
|
292
|
+
|
|
293
|
+
print(calculation_evidence("risk/assessment"))
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
## Complete module map
|
|
297
|
+
|
|
298
|
+
All calculation IDs, Python paths, input/output schemas, references,
|
|
299
|
+
limitations and direct-test links are in [`docs/MODULE_CATALOG.md`](docs/MODULE_CATALOG.md)
|
|
300
|
+
and `src/api581/data/python-api.schema.json`.
|
|
301
|
+
|
|
302
|
+
| Domain | Scope |
|
|
303
|
+
|---|---|
|
|
304
|
+
| `frequency` | generic, adjusted and management/system failure frequencies |
|
|
305
|
+
| `damage` | thinning, cracking, corrosion, HTHA, brittle, fatigue and mechanism screening |
|
|
306
|
+
| `inspection` | effectiveness, equivalence, history and coverage factors |
|
|
307
|
+
| `reliability` | Poisson, Weibull, renewal and failure-history primitives |
|
|
308
|
+
| `release` | gas/liquid/two-phase release rates, holes, isolation and source partition |
|
|
309
|
+
| `properties` | representative fluids, mixtures, saturation and flash contracts |
|
|
310
|
+
| `effects` | jet fire, pool fire, flash fire, fireball, BLEVE, blast and radiation |
|
|
311
|
+
| `events` | ignition, mitigation, PRD and event-tree primitives |
|
|
312
|
+
| `consequence` | release, toxic, flammable, environmental and financial consequence composition |
|
|
313
|
+
| `financial` | repair, cleanup, business interruption and monetary aggregation |
|
|
314
|
+
| `risk` | POF/COF integration, risk matrices, portfolio and damage handoff |
|
|
315
|
+
| `planning` | target crossing and inspection-planning primitives |
|
|
316
|
+
| `level1` | Level 1 flammable/toxic consequence summaries |
|
|
317
|
+
| `level2` | Level 2 source, scenario, dispersion and consequence summaries |
|
|
318
|
+
| `prd` | relief-device history, leakage, failure and consequence boundaries |
|
|
319
|
+
| `tank` | atmospheric-tank inventory, shell/bottom thinning, environment and finance |
|
|
320
|
+
| `dispersion` | grids, source handoff and optional SLABx/SLABx-LH2 native boundaries |
|
|
321
|
+
| `api520` | companion pressure-relief capacity and sizing utilities; outside the API-581 clause ledger |
|
|
322
|
+
|
|
323
|
+
Each domain has focused validation notes under [`docs/`](docs/), including
|
|
324
|
+
the acid/sour/amine/CO2/HF/HCl/sulfidic mechanisms, tank routes, two-phase
|
|
325
|
+
events, native dispersion, radiation, blast, inspection and thinning models.
|
|
326
|
+
|
|
327
|
+
## Integrated workflow
|
|
328
|
+
|
|
329
|
+
The library deliberately separates calculations from orchestration. Use
|
|
330
|
+
individual functions for auditable steps, or use `Workflow`, `Step` and
|
|
331
|
+
`run_workflow` for a declarative graph. A risk assessment consumes explicitly
|
|
332
|
+
qualified damage factors and four-hole consequence outputs; it does not invent
|
|
333
|
+
plant applicability, inspection data, material properties or FFS conclusions.
|
|
334
|
+
|
|
335
|
+
```python
|
|
336
|
+
from api581.workflow import Step, Workflow, run_workflow
|
|
337
|
+
|
|
338
|
+
workflow = Workflow(steps=[
|
|
339
|
+
Step(id="release", calculation_id="release/gas", input={...}),
|
|
340
|
+
Step(id="risk", calculation_id="risk/assessment", input={...}),
|
|
341
|
+
])
|
|
342
|
+
result = run_workflow(workflow)
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
See [`examples/`](examples/) for direct composition, risk handoff, tank,
|
|
346
|
+
source partition, native dispersion, toxic and inspection-planning examples.
|
|
347
|
+
|
|
348
|
+
## SLABx and SLABx-LH2 boundary
|
|
349
|
+
|
|
350
|
+
Native engines are optional and process-isolated. The adapter records package
|
|
351
|
+
version/importability, source fingerprints, actual grid extent, censoring and
|
|
352
|
+
premise diagnostics. It does not claim that a native result is a site model,
|
|
353
|
+
does not apply an invented LH2 safety factor, and does not silently fall back
|
|
354
|
+
to another dispersion engine. See:
|
|
355
|
+
|
|
356
|
+
- [`docs/NATIVE_DISPERSION_VALIDATION.md`](docs/NATIVE_DISPERSION_VALIDATION.md)
|
|
357
|
+
- [`docs/NATIVE_JET_VALIDATION.md`](docs/NATIVE_JET_VALIDATION.md)
|
|
358
|
+
- [`docs/NATIVE_FOOTPRINT_VALIDATION.md`](docs/NATIVE_FOOTPRINT_VALIDATION.md)
|
|
359
|
+
- [`docs/NATIVE_ENGINE_EVIDENCE.json`](docs/NATIVE_ENGINE_EVIDENCE.json)
|
|
360
|
+
|
|
361
|
+
## Verification and reproducibility
|
|
362
|
+
|
|
363
|
+
Local release verification:
|
|
364
|
+
|
|
365
|
+
```powershell
|
|
366
|
+
python scripts/final_audit.py
|
|
367
|
+
python scripts/verify_provenance.py
|
|
368
|
+
python scripts/verify_completion_matrix.py
|
|
369
|
+
python -m twine check tmp/release-final-20261025br/*
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
Current evidence includes:
|
|
373
|
+
|
|
374
|
+
- 11,848 passing tests and 3 optional skips
|
|
375
|
+
- 108 reference fixtures
|
|
376
|
+
- 509/509 direct test references
|
|
377
|
+
- canonical Nurion PBS receipt: 64/64 shards passed
|
|
378
|
+
- efficient Nurion receipt: 10/10 shards passed
|
|
379
|
+
- 16,000 broad input invariant cases
|
|
380
|
+
- native suite: 9/9 scripts passed
|
|
381
|
+
- 66 supporting-text clauses machine-reviewed and 10 public-data reviewed
|
|
382
|
+
|
|
383
|
+
The reproducibility and handoff record is in:
|
|
384
|
+
|
|
385
|
+
- [`docs/FINAL_AUDIT.md`](docs/FINAL_AUDIT.md)
|
|
386
|
+
- [`docs/COMPLETION_AUDIT.md`](docs/COMPLETION_AUDIT.md)
|
|
387
|
+
- [`docs/completion-matrix.json`](docs/completion-matrix.json)
|
|
388
|
+
- [`docs/release-manifest.json`](docs/release-manifest.json)
|
|
389
|
+
- [`docs/DEVELOPMENT_STATUS.md`](docs/DEVELOPMENT_STATUS.md)
|
|
390
|
+
- [`docs/VERIFICATION_COMMANDS.md`](docs/VERIFICATION_COMMANDS.md)
|
|
391
|
+
|
|
392
|
+
## Copyright and public-release boundary
|
|
393
|
+
|
|
394
|
+
The public release contains original implementation code, original
|
|
395
|
+
documentation, generated schemas, hashes and test receipts. It intentionally
|
|
396
|
+
does **not** include API standard PDFs, DOCX files, purchased tables or copied
|
|
397
|
+
standard text. Source-document filenames, byte counts and SHA-256 fingerprints
|
|
398
|
+
are retained only as provenance metadata where needed.
|
|
399
|
+
|
|
400
|
+
Read [`NOTICE.md`](NOTICE.md) and [`COPYRIGHT.md`](COPYRIGHT.md) before
|
|
401
|
+
redistributing or adding fixtures. The Apache-2.0 license applies to original
|
|
402
|
+
repository work only; it does not license API standards or third-party source
|
|
403
|
+
documents.
|
|
404
|
+
|
|
405
|
+
## Development handoff
|
|
406
|
+
|
|
407
|
+
Start with [`docs/DEVELOPMENT_STATUS.md`](docs/DEVELOPMENT_STATUS.md), then
|
|
408
|
+
read [`docs/MODULE_CATALOG.md`](docs/MODULE_CATALOG.md),
|
|
409
|
+
[`docs/completion-matrix.json`](docs/completion-matrix.json), and the final
|
|
410
|
+
audit receipt. New calculations must register a typed input/output contract,
|
|
411
|
+
references, limitations, direct tests and both directions of traceability.
|
|
412
|
+
Do not commit local source PDFs, credentials, runtime databases, Nurion working
|
|
413
|
+
directories or generated build folders.
|
|
414
|
+
|
|
415
|
+
## License
|
|
416
|
+
|
|
417
|
+
Original code and documentation are licensed under [Apache License 2.0](LICENSE).
|
|
418
|
+
See [`NOTICE.md`](NOTICE.md) for trademarks, standards and third-party-source
|
|
419
|
+
boundaries.
|