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.

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

Update documentation #194

Open
wbinventor opened this issue Aug 5, 2015 · 2 comments
Open

Update documentation #194

wbinventor opened this issue Aug 5, 2015 · 2 comments

Comments

@wbinventor
Copy link
Member

This is intended to start a conversation on the various features that have been implemented to the code over the last 6 months and which should be added to the documentation. Some items that come to mind that should be added to the online documentation before the next release include:

User's Guide

  • polar quadrature API
  • fixed source calculation API
  • FSR volume correction API
  • adjoint calculations
  • plotting centroids, eigenmodes
  • periodic boundary conditions

Theory & Methodology

  • k-nearest neighbor CMFD updates
  • krylov subspace solver
  • adjoint solver
@wbinventor wbinventor added this to the v0.2.1 milestone Aug 5, 2015
@wbinventor
Copy link
Member Author

Added periodic boundary conditions to this list.

@wbinventor
Copy link
Member Author

I compiled a list of updates we need to make to the documentation based on our "All Hands" day last week.

Installation

  • Remove deprecated --no-numpy flag
  • Add Matplotlib as required dependency

User's Guide

  • Polar quadratures
  • Fixed source and criticality calculations
  • Moderator rings
  • Convergence criteria
  • k-Nearest Neighbor CMFD
  • Periodic boundary conditions
  • Change Circle to ZCylinder
  • Changes to Material and openmoc.materialize
  • Add new capabilities in openmoc.plotter
  • Discussion of 3D geometries
  • Computing FSR / pin powers
  • Adjoint calculations
  • SPH factor calculator
  • FSR volume correction
  • Exponential evaluation options
  • Multi-eigenmode Krylov solver

Theory & Methodology

  • k-Nearest Neighbor CMFD
  • Incorporation of nu-scatter into k-eigenvalue
  • SuPerHomogenisation (SPH) factors
  • Adjoint calculations
  • Multi-eigenmode Krylov solver

Developer's Guide

  • Writing documentation
  • References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant