Comments (10)
Hmm, well now with these edits I think it is closer to being its own issue now, so maybe hold off on closing it just yet?
from moltres.
A contributing.md document exists and Moltres follows the MOOSE style guide and is not duplicated in this repo (because D.R.Y.). Please see my comments on the other issues with respect to these notes.
I understand that as a new user, you may feel confused by some of the documentation and I support improvements for clarity. I encourage those changes that you feel would be helpful. However, I also would like to take this moment to express that issues and PRs in this repository are part of the larger scope of professional engagements in ARFC over which the code of conduct applies. I'd like to request a more respectful and generous tone in such engagements to communicate due respect for the previous authors of this work, many of whom are your colleagues, one of whom is your advisor, and one of whom we are deeply grateful to for the sheer existence of Moltres. Entitling this issue "Insufficient documentation throughout Moltres" and characterizing the documentation situation as "generally insufficient" seems a bit baseless, given that moltres has been used by many students, including a complete stranger on another continent who required no assistance from us to incorporate Moltres simulations as a pivotal component of their PhD dissertation.
from moltres.
Since this issue merely exists to refer to other subissues, I'd like to close it as duplicative. What do you think @yardasol?
from moltres.
I agree that this issue should be closed as duplicative.
from moltres.
A contributing.md document exists and Moltres follows the MOOSE style guide and is not duplicated in this repo (because D.R.Y.). Please see my comments on the other issues with respect to these notes.
I understand that as a new user, you may feel confused by some of the documentation and I support improvements for clarity. I encourage those changes that you feel would be helpful. However, I also would like to take this moment to express that issues and PRs in this repository are part of the larger scope of professional engagements in ARFC over which the code of conduct applies. I'd like to request a more respectful and generous tone in such engagements to communicate due respect for the previous authors of this work, many of whom are your colleagues, one of whom is your advisor, and one of whom we are deeply grateful to for the sheer existence of Moltres. Entitling this issue "Insufficient documentation throughout Moltres" and characterizing the documentation situation as "generally insufficient" seems a bit baseless, given that moltres has been used by many students, including a complete stranger on another continent who required no assistance from us to incorporate Moltres simulations as a pivotal component of their PhD dissertation.
@katyhuff okay so I made some more edits and I think this issue is more appropriately worded now.
from moltres.
Thanks!!
from moltres.
I've just briefly checked through a few of the kernel .h
files and I noticed that some (e.g. GroupDiffusion.h
) are missing documentation.
We can make a list of these files and make the appropriate edits to the documentation. In case you didn't know, here's a thorough breakdown of an example Moltres input file. If you're planning to work on this issue, you can ping me when you need help.
from moltres.
Good idea with making the list. I've made a textfile in the docum (short for documentation) branch of my arfc repo that has the names of all the files in src/ and include/ and is ready to be filled in with what changes or additions we should make for each file. I don't anticipate needing help on that, and it'll be a good opportunity to really get familiar with the overall structure of Moltres. Once I have gone through all the files in those directories and filled in what needs to be done, I'll ping here. Let me know if you think there are other places in the repo that I should put on the list.
from moltres.
unassigning myself from this because I'm not likely to get around to it any time soon and am less familiar with Moltres than some of the other people in the group.
from moltres.
I'm closing this because the points here are covered by newer issues #179, #191, and #193
from moltres.
Related Issues (20)
- Replace the Nt action with a more intuitive name
- Tutorial issues
- Add additional installation instructions HOT 1
- Remove deprecated MOOSE code HOT 7
- moltres_xs.py maybe not compatiable with the newest version of OpenMC
- Removing unused params
- Replace deprecated NodalMaxValue
- Fix removal cross section generation in moltres_xs.py from OpenMC data
- where is the k-eff definition? HOT 1
- Add postprocessor for calculating neutron leakage
- CIVET: 'Mirror scheduled' failure
- Make PrecursorAction compatible with velocity vector variables derived from INSAD
- Welcome to Moltres Discussions! HOT 8
- Create a CI test for building documentation HOT 1
- Rename convoluted object names for clarity
- Extend PrecursorAction to support modeling with higher order precursor variables
- Add documentation on neutron diffusion theory on the Moltres website
- Compilation issue on MacOS with clang HOT 2
- Add override keyword to computeQpOffDiagJacobian in INSBoussinesqBodyForce
- Allow users to choose among Marshak, Mark, and Milne vacuum boundary conditions
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from moltres.