Skip to content

Commit

Permalink
Adding README to guide repo organization and contributions.
Browse files Browse the repository at this point in the history
  • Loading branch information
pshriwise committed Jul 9, 2024
1 parent 55bac1e commit 1204bc3
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
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.

0 comments on commit 1204bc3

Please sign in to comment.