Skip to content

035 readme file update #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fpepe-polito wants to merge 4 commits into
base: master
Choose a base branch
from
Open

035 readme file update #36

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
29a4acc
[035_readme_file_update], issue #35, updated README
fpepe-polito Sep 15, 2025
03ec241
[035_readme_file_update], issue #35, modified report contact and docu…
fpepe-polito Sep 15, 2025
dbe7e3f
[035_readme_file_update], issue #35, modified newcleo word style
fpepe-polito Sep 15, 2025
6a2481d
[035_readme_file_update], issue #35, modified description section
fpepe-polito Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
# 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 <em>new</em>cleo 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.

Modifications are currently under developemnt at <em>new</em>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).

Expand All @@ -17,11 +24,14 @@ 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 `matz [at] anl [dot] gov`
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.
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.