cyclus / cyclus/cyclus.github.com

[Task] Update Cycstub archetype development pages

Open
#420 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8
Forks
33
PR merge metrics
No merged PRs in 30d

Description

What is this task about?

Provide updates to the arche/hello_world_cpp.rst and arche/tutorial_cpp/* to be more clear for a user.

  • arche/hellow_world.rst:
  • Make it clear to a user to create tutorial directory and move to that directory before running cycstub command
  • arche/tour_cpp.rst:
  • In the section with cycstub commands, part of the input is the path: [path]:[library-name]:[archetype-name]
    but the path part is missing
  • When you start talking about the "implementation file", remind the reader that this is the .cc file created
  • Jumps from the .cc file back to the .h file -- should discuss all of the contents of the .h file then talk about the .cc file
  • arche/tutorial_cpp/setup.rst:
  • I'm not sure if the install_cyclus_standalone command the page tells you to use still works because after I do that and reinstall (need to update the command to install on the page) I get an error: Storage_unit_tests: error while loading shared libraries: libStorage.so: cannot open shared object file: No such file or directory
  • If we are are going to remove the install_cyclus_standalone, should we update it to USE_CYCLUS(...) in the first part of the src/CMakeLists.txt file?
  • If we have users set the verbosity to 2 when they run the storage example input file, the terminal output should include the time step number:
INFO1(core  ):Current time: 0
Hello, World!
 INFO1(core  ):Current time: 1
Hello, World!
 INFO1(core  ):Current time: 2
Hello, World!
  • arche/tutorial_cpp/state_var.rst:
  • Update install command
  • Update terminal output when running example with verbosity of 2 (see above)
  • arche/tutorial_cpp/toolkit.rst:
  • Update install instructions

Why is this task needed?

Routine documentation updating

Relevant resources or references

How can this issue be closed?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing arche/hello_world_cpp.rst, arche/tour_cpp.rst, and the files under arche/tutorial_cpp/, focusing on the current install commands and cited CMake usage. Reproduce the setup and storage example with verbosity 2 to verify the reported library error and expected output. Done means the pages contain working install instructions, clear paths and file explanations, and updated terminal output.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.