Skip to content

ORNL-MDF/Myna

Repository files navigation

Myna

NOTE: This repository contains working examples of the workflow, but on-going development may change directory structures, output files, etc. from previous versions.

Code style: black

Detailed documentation for Myna can be found at https://ornl-mdf.github.io/myna-docs/.

Description

Myna is a framework to facilitate modeling and simulation workflows for additive manufacturing based on build data stored in a digital factory framework, initially developed for the database structure maintained by ORNL MDF's Peregrine tool.

There are three top-level submodules within Myna:

  • core: contains class definitions for metadata, file types, and workflow components, as well as the core functionality for running Myna workflows
  • application: implementations of wrappers for various models to satisfy the requirements of the defined Myna workflow steps
  • database: implementations of readers for different database types

Installation

Myna is a Python package which requires Python 3. You must install it locally as an editable package using pip install -e ., which is a temporary requirement that will be changed in future releases. The myna package is not on PyPI. To install myna follow the instructions below. For additional details, see Getting Started.

git clone https://github.com/ORNL-MDF/Myna
cd Myna
pip install -e .

External, non-Python dependencies are required depending on which applications you intend to use:

Usage

Myna input files define the order of simulation steps and the options for each step. Optional workspaces can also be created as .yaml or .myna-workspace files that can be referenced to share common settings across multiple input files. See examples/solidification_part/readme.md for details on running an example case.

Attribution

If you use Myna in your work, please cite the version of Myna used via the Zenodo DOI (link to most recent release). In addition, please cite any of the relevant journal articles:

  • Knapp et al. (2025) describes the background for Myna and the 3DThesis, AdditiveFOAM, and ExaCA applications for melt pool and microstructure simulations.
  • Knapp et al. (2023) introduces the concept of leverging the digital thread for simulations using the precursor to Myna and provides details on the solidification data clustering approach.

The examples/Peregrine directory used for examples are from the publicly available Peregrine v2023-10 dataset. If you use this data, please cite Scime et al. (2023).

Development

See the guidelines on how to contribute.

License

Myna is distributed under an open source 3-clause BSD license.

About

Framework to facilitate simulation workflows and experimental databases for additive manufacturing

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 6