Skip to content

Commit

Permalink
Improving README a little bit
Browse files Browse the repository at this point in the history
  • Loading branch information
pshriwise committed Jul 10, 2024
1 parent 1204bc3 commit d8b0a24
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@ 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.
various capabilities in OpenMC from basic model building to advanced features
such as depletion/activation, CAD geometry universes, etc.

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.
Notebooks contained in the `main` branch of this repository can be expected to
work with the latest release 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.
Previous versions notebooks will be tagged with the corresponding OpenMC version
with which they are expected to 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
Expand Down

0 comments on commit d8b0a24

Please sign in to comment.