Skip to content
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

Jump to bottom

Readme update on license and citation #22

Merged
merged 2 commits into from
Jun 19, 2024
Merged

Readme update on license and citation #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53a3465
add note on licenses
nsryan2 Jun 19, 2024
ad055e7
add spot for citation
nsryan2 Jun 19, 2024
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# NEAR
NEAR (Non-Equilibrium Archetypes of Reactors): Houses cyclus archetypes for non-equilibrium reactors with core-loading and enrichment variability.

> [!Note]
> Cite this work as (pending)...

## ./Baseline/
Contains a single deployment of a traditional Cycamore reactor archetype along with the corresponding analysis notebook and output file.

Expand All @@ -11,4 +14,7 @@ Houses the Enrichment Versatile non-Equilibrium Reactor (EVER), a generic Cyclus
Houses the Core LOading Versatile non-Equilibrium Reactor (CLOVER), a generic Cyclus archetype that has the capability to update the loading pattern of a reactor core.

## ./writing/
This folder contains the writing on this project, and is governed by the license therein.
This folder contains the writing on this project, and is governed by the license therein.

> [!Important]
> This code is licensed under a BSD 3-Clause License, with the exception of the writing directory (which contains a separate license).