cyclus / cyclus/cyclus.github.com
New CEP or overhauled CEP2 for ecosystem
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
As seen in recent discussions about where a Mixer class should live (see cyclus/cycamore#399), the messaging on where different packages should live is not as clear as it should be.
CEP2 states that Cyclus should be for agent-based simulation (which necessarily includes archetypes), 2nd and 3rd party packages should be oriented around domain-specific models (explicitly including cycamore).
While it is understood that domain-specific models should not be in cyclus, it is not clear whether domain-agnostic models should be allowed in officially supported domain-specific packages.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading CEP2 and the linked cyclus/cycamore#399 discussion about where the Mixer class should live. Clarify whether domain-agnostic models belong in officially supported domain-specific packages, and document the resulting package-placement guidance in a new or overhauled CEP.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100