cyclus / cyclus/cyclus.github.com

Python developer tutorial should include DRE

Open
#284 1 comment 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

Currently, the python developer tutorial page does not include methods to implement DRE. However, the guide exists in the DRE page. Although it might be obvious to an observant developer, the Python archetype developer tutorial would be more complete if it went over the DRE implementation as well.

The C++ archetype developer tutorial implements DRE with buy_policy and sell_policy. This toolkit is not available when developing with python.

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 with the Python developer tutorial at http://fuelcycle.org/arche/tutorial_py/index.html and compare it with the DRE guide at http://fuelcycle.org/arche/dre.html and the C++ archetype tutorial's DRE section. Done means the Python tutorial explains how to implement DRE using the Python toolkit's available methods, while accounting for the absence of buy_policy and sell_policy.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.