From 29a4acc64b033b4f5f12c3bfa1be54e86eb905cb Mon Sep 17 00:00:00 2001 From: Francesco Pepe Date: Mon, 15 Sep 2025 13:07:52 +0200 Subject: [PATCH 1/4] [035_readme_file_update], issue #35, updated README --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ba0513f..b2edf47 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,23 @@ -# Ducted Assembly Steady State Heat Transfer Software (DASSH) +# Ducted Assembly Steady State Heat Transfer Software (DASSH-nc) - forked from ANL DASSH [![Build](https://github.com/dassh-dev/dassh/actions/workflows/ci.yml/badge.svg)](https://github.com/dassh-dev/dassh/actions) -[![codecov](https://codecov.io/gh/dassh-dev/dassh/branch/develop/graph/badge.svg)](https://app.codecov.io/gh/dassh-dev/dassh) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) +| | | +|----------------|--------------------| +| Author: | Francesco Pepe | +| Contributor: | Gabriele Ottino | + +DASSH-nc is a fork of the ANL DASSH (Ducted Assembly Steady State Heat Transfer Software) repository (https://github.com/dassh-dev/dassh). The Ducted Assembly Steady State Heat Transfer Software (DASSH) is an open-source tool for calculating temperature and flow distributions in hexagonal, ducted assemblies comprised of wire-wrapped pin bundles. DASSH is intended for use during the design process to provide a rapid assessment of the flow and temperature distribution, especially when assembly designs are in their early stages and not fully developed. +Modifications are currently under developemnt at _new_ cleo to extend its application domain. + ## Installation DASSH requires Python 3.6+. Detailed installation instructions can be found in the [user guide](https://github.com/dassh-dev/documents/blob/master/user_guide.pdf). -## Citing DASSH +## Literature on DASSH If you use DASSH in your research, please consider citing the following conference paper, the theory manual, or the user guide. * Milos Atz, Micheal A. Smith, Florent Heidet. “DASSH software for ducted assembly thermal hydraulics calculations – overview and benchmark”. Transactions of the American Nuclear Society 123 pp. 1673-1676 (2020). [URL](https://www.ans.org/pubs/transactions/article-49036/). * Milos Atz, Micheal A. Smith, Florent Heidet, "Ducted Assembly Steady State Heat Transfer Software (DASSH) - Theory Manual", ANL/NSE-21/33, Argonne National Laboratory, 2021. @@ -23,5 +30,8 @@ If you encounter issues installing or running DASSH or would like to report a bu * User guide: https://github.com/dassh-dev/documents/blob/master/user_guide.pdf * Theory manual: https://github.com/dassh-dev/documents/blob/master/theory_manual.pdf +User and Theory manuals cover the original _dassh_. +Please refer to #6 for documentation updates related to modifications implemented in this fork. + ## License DASSH is distributed under the [BSD-3](https://opensource.org/licenses/BSD-3-Clause) license. From 03ec2414f94005f6203dbbbf51528f0b9ac5e90a Mon Sep 17 00:00:00 2001 From: Francesco Pepe Date: Mon, 15 Sep 2025 14:48:45 +0200 Subject: [PATCH 2/4] [035_readme_file_update], issue #35, modified report contact and documentation section --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b2edf47..473f3dc 100644 --- a/README.md +++ b/README.md @@ -8,30 +8,30 @@ | Author: | Francesco Pepe | | Contributor: | Gabriele Ottino | -DASSH-nc is a fork of the ANL DASSH (Ducted Assembly Steady State Heat Transfer Software) repository (https://github.com/dassh-dev/dassh). +DASSH-nc is a *new*\ cleo fork of the ANL DASSH (Ducted Assembly Steady State Heat Transfer Software) repository (https://github.com/dassh-dev/dassh). The Ducted Assembly Steady State Heat Transfer Software (DASSH) is an open-source tool for calculating temperature and flow distributions in hexagonal, ducted assemblies comprised of wire-wrapped pin bundles. DASSH is intended for use during the design process to provide a rapid assessment of the flow and temperature distribution, especially when assembly designs are in their early stages and not fully developed. -Modifications are currently under developemnt at _new_ cleo to extend its application domain. +Modifications are currently under developemnt at *new*\ cleo to extend its application domain. ## Installation DASSH requires Python 3.6+. Detailed installation instructions can be found in the [user guide](https://github.com/dassh-dev/documents/blob/master/user_guide.pdf). -## Literature on DASSH +## Citing DASSH If you use DASSH in your research, please consider citing the following conference paper, the theory manual, or the user guide. * Milos Atz, Micheal A. Smith, Florent Heidet. “DASSH software for ducted assembly thermal hydraulics calculations – overview and benchmark”. Transactions of the American Nuclear Society 123 pp. 1673-1676 (2020). [URL](https://www.ans.org/pubs/transactions/article-49036/). * Milos Atz, Micheal A. Smith, Florent Heidet, "Ducted Assembly Steady State Heat Transfer Software (DASSH) - Theory Manual", ANL/NSE-21/33, Argonne National Laboratory, 2021. * Milos Atz, Micheal A. Smith, Florent Heidet, "Ducted Assembly Steady State Heat Transfer Software (DASSH) - User Guide", ANL/NSE-21/34, Argonne National Laboratory, 2021. ## Troubleshooting and reporting bugs -If you encounter issues installing or running DASSH or would like to report a bug, please reach out to the developer via `matz [at] anl [dot] gov` +If you encounter issues installing or running DASSH or would like to report a bug, please reach out to the developer via _francesco.pepe@newcleo.com_. ## Documentation * User guide: https://github.com/dassh-dev/documents/blob/master/user_guide.pdf * Theory manual: https://github.com/dassh-dev/documents/blob/master/theory_manual.pdf User and Theory manuals cover the original _dassh_. -Please refer to #6 for documentation updates related to modifications implemented in this fork. +Please refer to [#6](https://github.com/newcleo-dev-team/dassh_nc/issues/6) for documentation updates regarding the modifications implemented in this fork. ## License DASSH is distributed under the [BSD-3](https://opensource.org/licenses/BSD-3-Clause) license. From dbe7e3f081c65c41c9252be4e336db7c2ba2d73b Mon Sep 17 00:00:00 2001 From: Francesco Pepe Date: Mon, 15 Sep 2025 14:54:46 +0200 Subject: [PATCH 3/4] [035_readme_file_update], issue #35, modified newcleo word style --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 473f3dc..6ae512c 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ | Author: | Francesco Pepe | | Contributor: | Gabriele Ottino | -DASSH-nc is a *new*\ cleo fork of the ANL DASSH (Ducted Assembly Steady State Heat Transfer Software) repository (https://github.com/dassh-dev/dassh). +DASSH-nc is a newcleo fork of the ANL DASSH (Ducted Assembly Steady State Heat Transfer Software) repository (https://github.com/dassh-dev/dassh). The Ducted Assembly Steady State Heat Transfer Software (DASSH) is an open-source tool for calculating temperature and flow distributions in hexagonal, ducted assemblies comprised of wire-wrapped pin bundles. DASSH is intended for use during the design process to provide a rapid assessment of the flow and temperature distribution, especially when assembly designs are in their early stages and not fully developed. -Modifications are currently under developemnt at *new*\ cleo to extend its application domain. +Modifications are currently under developemnt at newcleo to extend its application domain. ## Installation DASSH requires Python 3.6+. Detailed installation instructions can be found in the [user guide](https://github.com/dassh-dev/documents/blob/master/user_guide.pdf). From 6a2481dcb14dbd01c3ff9f10ae8123fb16f9f282 Mon Sep 17 00:00:00 2001 From: Francesco Pepe Date: Mon, 15 Sep 2025 17:22:56 +0200 Subject: [PATCH 4/4] [035_readme_file_update], issue #35, modified description section --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ae512c..1db803c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ | Author: | Francesco Pepe | | Contributor: | Gabriele Ottino | -DASSH-nc is a newcleo fork of the ANL DASSH (Ducted Assembly Steady State Heat Transfer Software) repository (https://github.com/dassh-dev/dassh). +DASSH-nc is a newcleo fork of the ANL DASSH repository (https://github.com/dassh-dev/dassh). The Ducted Assembly Steady State Heat Transfer Software (DASSH) is an open-source tool for calculating temperature and flow distributions in hexagonal, ducted assemblies comprised of wire-wrapped pin bundles. DASSH is intended for use during the design process to provide a rapid assessment of the flow and temperature distribution, especially when assembly designs are in their early stages and not fully developed. @@ -24,13 +24,13 @@ If you use DASSH in your research, please consider citing the following conferen * Milos Atz, Micheal A. Smith, Florent Heidet, "Ducted Assembly Steady State Heat Transfer Software (DASSH) - User Guide", ANL/NSE-21/34, Argonne National Laboratory, 2021. ## Troubleshooting and reporting bugs -If you encounter issues installing or running DASSH or would like to report a bug, please reach out to the developer via _francesco.pepe@newcleo.com_. +If you encounter issues installing or running DASSH-nc or would like to report a bug, please reach out to the developer via _francesco.pepe@newcleo.com_. ## Documentation * User guide: https://github.com/dassh-dev/documents/blob/master/user_guide.pdf * Theory manual: https://github.com/dassh-dev/documents/blob/master/theory_manual.pdf -User and Theory manuals cover the original _dassh_. +User and Theory manuals cover the original DASSH. Please refer to [#6](https://github.com/newcleo-dev-team/dassh_nc/issues/6) for documentation updates regarding the modifications implemented in this fork. ## License