fusion-energy / neutronics-workshop

A workshop covering a range of fusion relevant analysis and simulations with OpenMC, DAGMC, Paramak and other open source fusion neutronics tools
MIT License
123 stars 52 forks source link

more concise readme to encourage reading #221

Closed shimwell closed 1 year ago

shimwell commented 1 year ago

I've cut down the readme as i kept getting slack messages, emails, discord messages etc from users who were having trouble running the examples as they were not using the docker image and had installed the latest release of openmc. currently the examples make use of the develop branch so they just don't all work on the latest release. the develop branch includes features that we need examples for so this is why it makes use of the develop branch. Anyway this cuts down the readme which i think will help draw attention to the recommendation to run this with docker.