Comments (8)
We need a plan for developer documentation:
- which parts are in Doxygen
- which parts are in Sphinx
- which parts are in GH issues
Will there be overlap (generally discouraged because of inevitable consistency problems)?
from dagmc.
Some things to track:
- user feature list vs. what is working and what is not
- decisions that will impact future development, e.g. conventions for naming of regions & materials
- build process/decisions
from dagmc.
Tasks for public pages that are created via Sphinx:
- Add a FluDAG bullet under 'Single Physics Analysis Tools' on svalinn.github.com (github.com/svalinn/svalinn.github.com). Note: This page is not in the doc-src tree.
- Add sub-bullet linking to repository
- Add sub-bullet linking to userguide (fludag-intro.rst)
- Create fludag-intro.rst with workflow documentation and user feature status table
- Put the user feature status table into Sphinx, link to the FluDAG section created in the previous step,
from dagmc.
For for the doxygen/Code Documentation portion
- Fill out Doxygen for the feature list wrapper functions with more detail.
- Add the fludag-calls.rst document containing a table of wrapper calls, descriptions and their status
from dagmc.
See https://github.com/svalinn/DAGMC/blob/fludagwork/FluDAG/README.rst#planning for some project management concepts
from dagmc.
Is this going to be done, it seems like it hasnt been touched in quite some time?
from dagmc.
Under its original title, thi is probably overcome by events and no longer necessary - it was intended as a mechanism to accomplish our goal for developing FluDAG. If we want to turn it into a documentation issue, then we can probably move it to existing issues on documentation or make a new issue.
from dagmc.
overcome by events
from dagmc.
Related Issues (20)
- DBUILD_MW_REG_TESTS requires h5m models that can't be found as URL missing HOT 9
- Add information on representation of metadata and topological relationships HOT 2
- dagmc tet mesh tallies 5.5x higher when run with MPI version of dag-mcnp6.2 HOT 6
- Remove DagMC class from MOAB namespace HOT 1
- Tests build with installed version of DAGMC if present HOT 8
- Windows Build Failure with Gtest HOT 7
- Can we detect sheet bodies?
- test dagmc compile with double down in Docker file CI
- Build error HOT 11
- CI requires contributors to build/publish packages
- Add CI soft test for newer/newest HDF5 version HOT 3
- Docker build error HOT 3
- Review HDF5 dependencies HOT 4
- Implicit Complement Position in DAGMC Indices HOT 4
- Allow implicit complement material assignment on empty group/block
- Switch to default `FindMOAB.cmake` HOT 7
- Surface has no facets warning HOT 7
- Failiure to build DAGMC with Double Down HOT 1
- Integration of FLUKA with DAGMC in CI HOT 6
- Windows CI is failing HOT 3
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 dagmc.