-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding README to guide repo organization and contributions.
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
OpenMC Notebooks | ||
---------------- | ||
|
||
This repository contains a set of example Jupyter notebooks demonstrating | ||
various capabilities in OpenMC from model building to advanced features like | ||
depletion/activation and CAD geometry. | ||
|
||
Notebook versioning | ||
------------------- | ||
|
||
Notebooks contained in the `main` branch of this repository should work with the | ||
latest version of OpenMC. Note, `main` **is not the default branch of this | ||
repository** and must be checked out after cloning the repo. | ||
|
||
Previous versions of the notebooks will be tagged with the corresponding OpenMC | ||
version with which they work. These tags can be used to checkout notebooks | ||
ensured to be compatible with the corresponding release of OpenMC. | ||
|
||
Continuous development of these notebooks occurs in the `develop` branch, the | ||
default branch of this repository. We ask that any updates or contributions to | ||
the repository occur based on this branch. |