Add initial data dict
This commit is contained in:
Nick Touran
parent
fb28c6c5c5
commit
36fcb5f260
19 changed files with 784 additions and 116 deletions
|
|
@ -1,3 +1,14 @@
|
|||
@techreport{barrieroInformationManagementProcess2010,
|
||||
title = {Information {{Management Process Description Guideline}}},
|
||||
author = {Barriero, Amy},
|
||||
year = 2010,
|
||||
number = {PDG01-2010},
|
||||
institution = {NIRMA},
|
||||
url = {https://international.anl.gov/training/materials/6H/Gilbert/PDG02%20Documents%20and%20Records%20Process%20Description.pdf},
|
||||
langid = {american},
|
||||
file = {/pool/Reading/Nuclear/institutions/nirma/PDG01 Information Management Process Description.pdf}
|
||||
}
|
||||
|
||||
@misc{cahillDesignPhilosophyBrief2025,
|
||||
title = {Design {{Philosophy Brief}}},
|
||||
author = {Cahill, William},
|
||||
|
|
@ -6,6 +17,44 @@
|
|||
url = {https://maritimesai.kiteworks.com/#/file/8b92c7cb-4444-4a3e-aba6-fdf328f7d2f8?currentPage=1}
|
||||
}
|
||||
|
||||
@techreport{cloverDocumentControlRecords2010,
|
||||
title = {Document {{Control}} and {{Records Management Process Description}}},
|
||||
author = {Clover, Bill},
|
||||
year = 2010,
|
||||
number = {PDG02-2010},
|
||||
institution = {NIRMA},
|
||||
url = {https://international.anl.gov/training/materials/6H/Gilbert/PDG02%20Documents%20and%20Records%20Process%20Description.pdf},
|
||||
langid = {american},
|
||||
file = {/pool/Reading/Nuclear/institutions/nirma/PDG02 Documents and Records Process Description.pdf}
|
||||
}
|
||||
|
||||
@techreport{fleerReactorTechnologyStudy25,
|
||||
title = {Reactor {{Technology Study}}},
|
||||
author = {Fleer, D and Edens, A and Ciocco, S and Jacqueline, K},
|
||||
year = 25,
|
||||
month = nov,
|
||||
number = {B4M-ES-121043},
|
||||
institution = {BWXT},
|
||||
url = {https://kiteworks.bwxt.com/web/file/416b69b9-4c5c-44c9-9605-40a25e181493?currentPage=1},
|
||||
copyright = {Export Controlled},
|
||||
file = {/home/nick/pool/Users/Nick/Documents/2025/What is Nuclear LLC/jobs/Marine/AMS docs/B4M-ES-121043_Rev001.pdf}
|
||||
}
|
||||
|
||||
@techreport{halpinInformationManagementNuclear1978d,
|
||||
title = {Information Management for Nuclear Power Stations: Project Description},
|
||||
shorttitle = {Information Management for Nuclear Power Stations},
|
||||
author = {Halpin, D. W.},
|
||||
year = 1978,
|
||||
month = mar,
|
||||
number = {ORO-5270-1},
|
||||
institution = {Georgia Inst. of Tech., Atlanta (USA). School of Civil Engineering},
|
||||
doi = {10.2172/6543303},
|
||||
url = {https://www.osti.gov/biblio/6543303},
|
||||
abstract = {A study of the information management structure required to support nuclear power plant construction was performed by a joint university-industry group under the sponsorship of the Department of Energy (DOE), formerly the Energy Research and Development Administration (ERDA). The purpose of this study was (1) to study methods for the control of information during the construction and start-up of nuclear power plants, and (2) identify those data elements intrinsic to nuclear power plants which must be maintained in a structured format for quick access and retrieval. Maintenance of the massive amount of data needed for control of a nuclear project during design, procurement, construction, start-up/testing, and operational phases requires a structuring which allows immediate update and retrieval based on a wide variety of access criteria. The objective of the research described has been to identify design concepts which support the development of an information control system responsive to these requirements. A conceptual design of a Management Information Data Base System which can meet the project control and information exchange needs of today's large nuclear power plant construction projects has been completed and an approach recommended for development and implementation of a complete operational system.},
|
||||
langid = {english},
|
||||
file = {/pool/Reading/Nuclear/process/configuration management/Information Management for Nuclear Power Stations 1978/Halpin - 1978 - Information management for nuclear power stations project description.pdf}
|
||||
}
|
||||
|
||||
@misc{imoCodeSafetyNuclear1982,
|
||||
title = {Code of {{Safety}} for {{Nuclear Merchant Ships}}},
|
||||
author = {IMO},
|
||||
|
|
@ -15,3 +64,27 @@
|
|||
publisher = {Internaional Maritime Organization},
|
||||
url = {https://wwwcdn.imo.org/localresources/en/KnowledgeCentre/IndexofIMOResolutions/AssemblyDocuments/A.491(12).pdf}
|
||||
}
|
||||
|
||||
@techreport{renuartAdvancedNuclearTechnology2014,
|
||||
title = {Advanced {{Nuclear Technology}}: {{Data-Centric Configuration Management}} for {{Efficiency}} and {{Cost Reduction}}: {{An Economic Basis}} for {{Implementation}}},
|
||||
author = {Renuart, R.},
|
||||
year = 2014,
|
||||
month = dec,
|
||||
number = {3002003126},
|
||||
pages = {170},
|
||||
institution = {EPRI},
|
||||
url = {https://www.epri.com/research/products/3002003126},
|
||||
abstract = {The Electric Power Research Institute (EPRI) Advanced Nuclear Technology (ANT) Program has been working on defining the tools that can be a part of an effective configuration management (CM) system. This includes the potential use of modern digital data management tools that can be useful not only across the plant life cycle, including engineering, procurement, construction (EPC), and decommissioning, but also for the management of plant configuration—control of the licensing basis, plant operation, and input and control of many plant programs.},
|
||||
langid = {american},
|
||||
file = {/home/nick/pool/Reading/Nuclear/process/configuration management/Advanced Nuclear Technology:
|
||||
Data-Centric Configuration Management for
|
||||
Efficiency and Cost Reduction 000000003002003126.pdf}
|
||||
}
|
||||
|
||||
@misc{SQLModel,
|
||||
title = {{{SQLModel}}},
|
||||
url = {https://sqlmodel.tiangolo.com/},
|
||||
abstract = {SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.},
|
||||
langid = {english},
|
||||
file = {/home/nick/Zotero/storage/MA9HAJ52/sqlmodel.tiangolo.com.html}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
---
|
||||
rmdc-systems:
|
||||
# This file contains a listing of specific software systems
|
||||
# used to implement information management. Data from this file
|
||||
# is brought into procedures as appropriate.
|
||||
RMDC:
|
||||
- name: NukeVault
|
||||
description: Specialized commercial records management system
|
||||
use-cases: Storing Documents and Records generated during design of Project X
|
||||
|
|
@ -8,3 +10,5 @@ rmdc-systems:
|
|||
description: A place where our suppliers can get documents
|
||||
use-cases: External suppliers send documents/records to us
|
||||
location: Online
|
||||
Data Management:
|
||||
- name: Data Dictionary
|
||||
|
|
|
|||
|
|
@ -18,7 +18,8 @@ sys.path.insert(0, SRC)
|
|||
import datetime
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
company_name = "Applied Maritime Sciences"
|
||||
company_name = "Applied Maritime Sciences, LLC"
|
||||
project_name = "Project 1959"
|
||||
project = f"{company_name} Governing Documents"
|
||||
author = company_name
|
||||
release = "1.0"
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
- name: Component Cooling Water System
|
||||
abbrev: CCW
|
||||
functions:
|
||||
- >
|
||||
Transfer heat from the following components to the RPSW system by CCW
|
||||
heat exchangers during normal operation, scheduled and unscheduled
|
||||
shutdowns, including hot and cold maintenance, and during refueling.
|
||||
name: Component Cooling Water System
|
||||
abbrev: CCW
|
||||
functions:
|
||||
- >
|
||||
Transfer heat from the following components to the RPSW system by CCW
|
||||
heat exchangers during normal operation, scheduled and unscheduled
|
||||
shutdowns, including hot and cold maintenance, and during refueling.
|
||||
|
||||
* Decay heat removal system heat exchangers
|
||||
* Makeup and purification system letdown heat exchangers
|
||||
* Reactor coolant pump heat exchangers
|
||||
* Control rod drive mechanism cooling jackets
|
||||
* Suppression pool heat exchangers
|
||||
* Decay heat removal system heat exchangers
|
||||
* Makeup and purification system letdown heat exchangers
|
||||
* Reactor coolant pump heat exchangers
|
||||
* Control rod drive mechanism cooling jackets
|
||||
* Suppression pool heat exchangers
|
||||
|
|
|
|||
|
|
@ -1,18 +1,18 @@
|
|||
- name: Reactor Compartment Ventilation System
|
||||
abbrev: RCV
|
||||
safety class: II
|
||||
functions:
|
||||
- Controlling radioactive gaseous release to the environment
|
||||
during both normal and emergency (post-LOCA) operation and
|
||||
maintenance of a low level of airborne radioactivity in
|
||||
the reactor compartment and auxiliary spaces to permit
|
||||
entry during normal operation or during both schedule and
|
||||
unscheduled shutdown.
|
||||
- Removing heat to the environment from sources within the reactor
|
||||
compartment
|
||||
- Containment purging prior to manned entry for maintenance and/or
|
||||
inspection. Containment purging would be accomplished only when
|
||||
the reactor is at or below hot shutdown conditions; i.e. decay heat
|
||||
system is operating.
|
||||
- Provide a source of clean air to the control areas if high
|
||||
radioactivity levels are present off ship.
|
||||
name: Reactor Compartment Ventilation System
|
||||
abbrev: RCV
|
||||
safety class: II
|
||||
functions:
|
||||
- Controlling radioactive gaseous release to the environment
|
||||
during both normal and emergency (post-LOCA) operation and
|
||||
maintenance of a low level of airborne radioactivity in
|
||||
the reactor compartment and auxiliary spaces to permit
|
||||
entry during normal operation or during both schedule and
|
||||
unscheduled shutdown.
|
||||
- Removing heat to the environment from sources within the reactor
|
||||
compartment
|
||||
- Containment purging prior to manned entry for maintenance and/or
|
||||
inspection. Containment purging would be accomplished only when
|
||||
the reactor is at or below hot shutdown conditions; i.e. decay heat
|
||||
system is operating.
|
||||
- Provide a source of clean air to the control areas if high
|
||||
radioactivity levels are present off ship.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
- name: Fuel handling equipment
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
name: Fuel handling equipment
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
|
|
|
|||
|
|
@ -1,49 +0,0 @@
|
|||
- name: Reactor vessel and closure head
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Primary coolant pump
|
||||
desc: Includes motors, coolers, valves, and piping
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 4
|
||||
tags: INTERFACE
|
||||
- name: Reactor vessel internals
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Steam generator
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 12
|
||||
tags: INTERFACE
|
||||
- name: Pressurizer
|
||||
desc: Pressurizer with spray and surge line
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Nuclear steam plant supports and restraints
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Control rod drive service structure
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Reactor coolant system insulation
|
||||
desc: >
|
||||
Includes insulation for:
|
||||
|
||||
* Reactor vessel and closure head
|
||||
* Pressurizer
|
||||
* Surge and spray line piping
|
||||
* Reactor coolant pumps
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Primary Coolant System
|
||||
======================
|
||||
|
||||
.. datatemplate:yaml:: pcs.yaml
|
||||
:template: system.tmpl
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
name: Primary Coolant System
|
||||
abbrev: PCS
|
||||
functions:
|
||||
- Remove heat from the core during normal operation
|
||||
- Generate steam
|
||||
equipment:
|
||||
- name: Reactor vessel and closure head
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Primary coolant pump
|
||||
desc: Includes motors, coolers, valves, and piping
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 4
|
||||
tags: INTERFACE
|
||||
- name: Reactor vessel internals
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Steam generator
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 12
|
||||
tags: INTERFACE
|
||||
- name: Pressurizer
|
||||
desc: Pressurizer with spray and surge line
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Nuclear steam plant supports and restraints
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Control rod drive service structure
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Reactor coolant system insulation
|
||||
desc: >
|
||||
Includes insulation for:
|
||||
|
||||
* Reactor vessel and closure head
|
||||
* Pressurizer
|
||||
* Surge and spray line piping
|
||||
* Reactor coolant pumps
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
|
|
@ -1,6 +1,5 @@
|
|||
|
||||
- name: Control rod drive mechanisms
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 37
|
||||
tags: INTERFACE
|
||||
name: Control rod drive mechanisms
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 37
|
||||
tags: INTERFACE
|
||||
|
|
|
|||
|
|
@ -1,18 +1,20 @@
|
|||
- name: Primary biological shielding
|
||||
desc: >
|
||||
Consists of shielding water tanks at
|
||||
name: Shielding System
|
||||
equipment:
|
||||
- name: Primary biological shielding
|
||||
desc: >
|
||||
Consists of shielding water tanks at
|
||||
|
||||
* Top
|
||||
* Vertical cylinder
|
||||
* Lower-inner bottom
|
||||
* Pressure suppression system
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Reactor enclosure/secondary biological shielding
|
||||
desc: Consists of 3-inch-thick steel bulkheads
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
* Top
|
||||
* Vertical cylinder
|
||||
* Lower-inner bottom
|
||||
* Pressure suppression system
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
- name: Reactor enclosure/secondary biological shielding
|
||||
desc: Consists of 3-inch-thick steel bulkheads
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
- name: Collision barrier
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
equipment:
|
||||
- name: Collision barrier
|
||||
params:
|
||||
- name: Quantity
|
||||
val: 1
|
||||
tags: INTERFACE
|
||||
|
|
|
|||
|
|
@ -8,4 +8,10 @@ Plant
|
|||
Reactor/index
|
||||
Ship/index
|
||||
Shipyard/index
|
||||
*
|
||||
*
|
||||
|
||||
|
||||
.. plant-data-table:: plant
|
||||
:columns: PBS, Value, Abbrev, Description, Tags
|
||||
:max-depth: 4
|
||||
:hide-empty:
|
||||
127
documents/procedures/administration/information_management.rst
Normal file
127
documents/procedures/administration/information_management.rst
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
|
||||
Information Management Plan
|
||||
===========================
|
||||
|
||||
Purpose
|
||||
-------
|
||||
This plan is the highest-level description of how information is
|
||||
managed at |inst|. It defines the information management requirements
|
||||
and explains the chosen processes and tools that meet the requirements.
|
||||
|
||||
Scope
|
||||
-----
|
||||
This plan applies to creation, storage, exchange, and retirement of project
|
||||
information related to |project|. This includes plant configuration management
|
||||
data as defined in :cite:p:`barrieroInformationManagementProcess2010`. The plan
|
||||
is not limited to information affecting quality, it also includes business
|
||||
information.
|
||||
|
||||
|
||||
Background
|
||||
----------
|
||||
The potential benefits of the digital transformation are well known across all
|
||||
business sectors. Numerous commercial nuclear information management studies
|
||||
have further suggested that properly implemented information management can improve
|
||||
efficiency and quality while reducing costs
|
||||
:cite:p:`halpinInformationManagementNuclear1978d,agencyInformationTechnologyNuclear2010,barrieroInformationManagementProcess2010,renuartAdvancedNuclearTechnology2014`
|
||||
In addition, management of information related to product quality is subject
|
||||
to nuclear quality regulations in all jurisdictions.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
.. req:: Quality-related information shall be managed in accordance with 10 CFR 50 Appendix B
|
||||
:id: R_INFO_APPB
|
||||
:links: R_10CFR50_APPB
|
||||
:tags: quality
|
||||
:basis: Compliance with Appendix B is necessary for licensing
|
||||
|
||||
Note that non-quality related information is not necessarily subject
|
||||
to this requirement.
|
||||
|
||||
.. req:: A data dictionary shall be maintained defining controlled data
|
||||
:id: R_DATA_DICT
|
||||
:basis: It will provide a central reference for all project members to
|
||||
find specific, precise, and up-to-date data definitions to enable
|
||||
unambiguous communications and collaboration.
|
||||
|
||||
The dictionary shall define data types, data fields, constraints on the
|
||||
fields, relationships between the data, source, sensitivity, usage,
|
||||
owner/steward, sample values, and transformation logic, as applicable. It
|
||||
shall be revision controlled such that changes can be clearly seen and
|
||||
remembered.
|
||||
|
||||
.. req:: Data shall be managed such that data exchanges and transformations between
|
||||
parties and systems can be readily automated
|
||||
:id: R_DATA_EXCHANGE
|
||||
:basis: Over the project life, numerous parties and systems will ramp up
|
||||
and down due to changing relationships and technologies. Automated data
|
||||
exchanges are expected to improve the ease, cost, speed, and quality of
|
||||
the inevitable exchanges and transformations.
|
||||
|
||||
This effectively requires rich data import and export capabilities
|
||||
in each tool used to manage data.
|
||||
|
||||
.. req:: Data shall be subject to role-based access controls (RBAC) or stronger
|
||||
:id: R_DATA_ACCESS
|
||||
:basis: Role-based access control (RBAC) is a strong standard
|
||||
covering the needs of commercial nuclear information
|
||||
from export control and business sensitivity perspectives.
|
||||
|
||||
More sensitive data, such as Security Related Information,
|
||||
may use stronger access controls such as ABAC or MAC.
|
||||
|
||||
Implementation
|
||||
--------------
|
||||
This section defines the specific implementation of the requirements.
|
||||
|
||||
General principles
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
A hub data architecture has been chosen for this project, based on
|
||||
arguments and experiences in :cite:p:`agencyInformationTechnologyNuclear2010`.
|
||||
|
||||
.. figure:: /_static/data-hub.png
|
||||
|
||||
Hub architecture, from :cite:p:`agencyInformationTechnologyNuclear2010`
|
||||
|
||||
This is designed to enable rapid integration of a wide variety of partner
|
||||
organizations, specialized information management tools, and engineering/design
|
||||
tools while striving to future-proof the multi-decade project.
|
||||
|
||||
The underlying data layer consists of:
|
||||
|
||||
* Structured text (e.g. YAML, XML, JSON) controlled in version-controlled repositories
|
||||
* Databases (e.g. Postgres)
|
||||
* Documents/drawings (PDFs, native files, HTML) stored on corporate drives and managed
|
||||
by the Records Management/Document Control system
|
||||
* Technical data (3D models, simulation input/output, laser scans, schedule dumps) stored
|
||||
on corporate drives, managed by the Technical Data Management system
|
||||
|
||||
Above the data layer sits the data authoring and manipulation layer, which includes:
|
||||
|
||||
* Office tools: word processors, spreadsheets, text editors, IDEs, etc., including
|
||||
online collaboration tools
|
||||
* PM tools: Primavera P6, HR tools
|
||||
* Engineering tools: SolidWorks, ANSYS, CASMO, MCNP, Intergraph, Revit
|
||||
* Construction tools
|
||||
* Maintenance tools
|
||||
|
||||
One-way or bidirectional data exchanges between tools and institutions occur
|
||||
through the API, which reads the data layer and presents data representations to
|
||||
authorized users or services in clearly-defined formats over the network.
|
||||
|
||||
.. _info-mgmt-data-dict:
|
||||
|
||||
Data Dictionary
|
||||
^^^^^^^^^^^^^^^
|
||||
The data dictionary is defined and maintained as described in
|
||||
:need:`I_DATA_DICT`.
|
||||
|
||||
The data dictionary itself is located at :ref:`data-dict`.
|
||||
|
||||
|
||||
.. insert render of the data dictionary table here.
|
||||
|
||||
Technology stack
|
||||
^^^^^^^^^^^^^^^^
|
||||
.. insert render of the IT systems table here.
|
||||
12
documents/schedule/index.rst
Normal file
12
documents/schedule/index.rst
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
.. raw:: latex
|
||||
|
||||
\begin{landscape}
|
||||
|
||||
Schedule
|
||||
########
|
||||
|
||||
.. schedule:: _data/schedule.yaml
|
||||
|
||||
.. raw:: latex
|
||||
|
||||
\end{landscape}
|
||||
Loading…
Add table
Add a link
Reference in a new issue