Subject says it all.

Should this information be mentioned in readme?

Otherwise, it is giving me file-not-found error.

cycweb (source) > make gh-preview
sphinx-build -b html -d ./gh-build/doctrees source ./gh-build
Making output directory...
Running Sphinx v1.1.3

Exception occurred:
File "/usr/lib/python2.7/dist-packages/sphinx/cmdline.py", line 188, in main
warningiserror, tags)
File "/usr/lib/python2.7/dist-packages/sphinx/application.py", line 102, in init
confoverrides or {}, self.tags)
File "/usr/lib/python2.7/dist-packages/sphinx/config.py", line 216, in init
exec code in config
File "/home/olzhas/cyclus/cycweb/source/conf.py", line 52, in
verout = subprocess.check_output(['cyclus', '--version']).split()
File "/usr/lib/python2.7/subprocess.py", line 537, in check_output
process = Popen(stdout=PIPE, _popenargs, *_kwargs)
File "/usr/lib/python2.7/subprocess.py", line 679, in init
errread, errwrite)
File "/usr/lib/python2.7/subprocess.py", line 1249, in _execute_child
raise child_exception
OSError: [Errno 2] No such file or directory
The full traceback has been saved in /tmp/sphinx-err-lRq3cO.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
Either send bugs to the mailing list at http://groups.google.com/group/sphinx-dev/,
or report them in the tracker at http://bitbucket.org/birkenfeld/sphinx/issues/. Thanks!
make: *** [gh-preview] Error 1

of the website to read "1.0 has been released"

This will include

• updating or removing the current wishlist at http://cyclus.github.com/basics/introduction.html#research-areas.
• adding new and revised detailed external development wishlist to its own page. Utilize hangout notes.
• putting a link to that wishlist in the sidebar, near the glossary.
• adding a link to the wishlist to a prominent part of the cyclus.github.com landing page.

The toaster example could be improved by walking it through all the way to a running fuel cycle example. As it stands, there is no real payoff in terms of "look I made the computer do something." Right now it feels more like "hey, I edited a bunch of text files."

Three steps :

• identify (read through the website and determine what words are confusing)
• define (make a glossary page)
• hyperlink (words that are confusing should hyperlink to the library)

So, I just noticed that the doi citation rendered on the homepage neglects the doi url, even though it appears on my local build.

Anyone know why?

The current site:

My local build:

this is just so we don't forget, as if we could.

giving this one to @gonuke

As @FlanFlanagan pointed out at SCI on 10/4/13, our rng examples on the website are not strictly up to date (even with Cycamore v0.2). We should determine the best way to make sure these are up to date. I can immediately think of a few options:

• don't provide rng on the website (i.e., use github as the only source)
• provide a hook (or update manually) during the tagging/release process that copies the current versions

For now, we need to update the website.

@scopatz, should we bring this discussion to the list serv?

Write a page/pages on the fundamental elements of a Cyclus simulation environment, e.g. BookKeeper, Timer, Logger, as part of the developer document.

for 1.0

for input files

Having followed precisely the directions in the README, I've hit a snag in the instructions.

It looks like they're out of date with commit e202e91. I assume we can mostly copy-paste from cnerg.github.com's readme, but I thought I'd throw this @scopatz's way for now to do with as he sees fit. I haven't messed with the github page makefiles in a long time (ever?) and am long due for some prelim writing today, so maybe he has time to give this a quick once-over.

In the GettingAndBuildingCyclus page, there should be new documentation addressing the cyclopts and coin dependencies to be introduced in cyclus core pull request #198.

With @rwcarlsen's recent output database update to add simulation id's, it's probably time we update the output db webpage (http://cyclus.github.io/devdoc/output_dbase.html). The schema needs to be updated for sure, likely a section should be added about dealing with multiple simulations, and there may be some out of date language in general.

We should also determine (perhaps as a group @katyhuff, @gonuke) where we want to talk about our output abstraction interface. More precisely, we effectively support sqlite output directly at the current time, and thus we provide this information on the website. However, we also, structurally, support other output database-like instances through our abstract interface. Where (if at all) should such documentation live on website? Is the doxygen documentation good enough?

Perhaps its time for a renewed discussion on this front in general (we keep flirting with digging deeper into the website vs. doxygen vs. incorporating doxygen in the website discussion). Perhaps we can bring @zwelchWI in as well, since he's the resident expert practitioner regarding these issues?

The videos here http://fuelcycle.org/kernel/main.html seem to break (not render correctly) under some builds. I've only just noticed it and they work now. We can close this after more observations if this was just a one-off issue with my browser.

This page should talk about the shape argument to AddVal() and what it does - ie applies a max size to VL types.

Cyclus on VM image is build in 2012 so it is old. May update to 0.2v.
In addition, I noticed that Firefox redirects to a new tab with xml guts of VM image instead of downloading it upon hitting 'image' on 'cyclus.github.io/devdoc/get_and_build.html'

low priority

Tomasz recently went through the process of building cyclus and its dependencies and has some suggestions on how to clarify the process. We should review his suggestions and incorporate them as needed.

The suggestions themselves were provided to the user list.

• Writing XML input files
• Running Sims from Web @rwcarlsen
• Building/Running using conda binaries @zwelchWI

per the discussion here: https://groups.google.com/forum/#!topic/cyclus-dev/MkdT1wcu_BQ

in the module developer's guide

We currently have to update two sources of information for installation instructions. One is the get and build page in this website and the other is the READMEs. We should only have to do this once, and I would prefer to keep installation information in the READMEs.

It is possible, however, to reference other rst files. PyNE does this, e.g.:

.. include:: ../../readme.rst
    :start-after: .. install-start
    :end-before: .. install-end

The main difference between PyNE's file structure and ours is that their documentation (website source) is in their source code repository, whereas ours is separate and our source code is distributed amongst (currently) 3 repositories.

In order to do this, our cyclus.github.com repository needs a conf.py that defines a variable for each repo we want to pull a readme section from, e.g. CYCLUS_README_PATH. The reference would then look like:

.. include:: CYCLUS_README_PATH/README.rst
    :start-after: .. install-start
    :end-before: .. install-end

Sphynx will then grab the appropriate sections during the make html step, and we can achieve our goal of having a single source file for any given install step. That being said, if those readmes are updated in the future, the website will have to be rebuilt to match those updates. However, that's an acceptable price to pay given the current state.

This is what prints when I load the table in my browser:

GET file://fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono net::ERR_FILE_NOT_FOUND dbtypes.html:16
Uncaught ReferenceError: state is not defined cloud.js:158
(anonymous function) cloud.js:158
fire jquery.js:1075
self.fireWith jquery.js:1193
jQuery.extend.ready jquery.js:435
DOMContentLoaded jquery.js:949
event.returnValue is deprecated. Please use the standard event.preventDefault() instead. jquery.js:3526

The readme should include:

• instructions on how to modify/rebuild the site (including what files not to modify)
• instructions to keep content update and build commits separate.

@rwcarlsen has made some improvements to the CLI, specifically regarding output file names. I was wondering if he would mind updating the github page (http://cyclus.github.io/usrdoc/running_sims.html)?

to match the feature in cyclus/cyclus#948

Note that every one of the tables described below has a “SimId” column that is not shown.

We need to actually show these. The way the "Understanding the Database" page is written right now it is too easy to miss and the SimId is an important concept that we can't gloss over. Someone skipping to the table descritions would implement the wrong schema.

In issue 14 in the cyclus/core repository https://github.com/cyclus/core/issues/14 , changes were made enabling an installation step. Document this on the website.

For posterity, we should document what files we configure and how we configure them. This will also explain why the resulting files are not version controlled.

There are a bunch of little things on the toaster example that if you copy/paste the code over it will fail to compile. These come from API changes, I am assuming. The one that sticks out in my mind is in removeResource(), trans.comod is actually a function trans.comod().