General updates to the website
@abachma2 is already working on this.
Since Mar 21, 2024.
Assessment
This issue has not been assessed yet.
Description
This issue is meant as a list to keep track of various changes on the website, such as updates, typos, redesigns, etc. We will do our best to make sure things get updated in a timely manner. Please be sure to name the exact file that should be changed, and ideally the line(s) of the file to be changed.
To add a new item, please edit this comment, using a checkbox for each item
Moving all subtasks into the description so that they are tracked in a single place (@gonuke )
From our initial discussion (@nsryan2 ):
- Remove mentions of VM support (people can build their own VM and then install cyclus inside it)
- Remove mentions of cyclus-build-deps conda install mentions (there’s a flag you can use to install only dependencies from a conda package).
- Update installation minimum packaging
Warnings/issues to handle (@abachma2 ):
- #413
-
sourcec/cep/cep27.rstlines 32, 34,107, 113, 114, 123, 129, 137, 141, 151, 155, 156, 165, 171, 179, 183 -
source/cep/cep3.rstline 2 -
source/cite/index.rstline 47 -
source/newsletters/oct2017.rstline 111 -
source/previous/index.rstline 111 -
source/user/server.rstline 73 -
source/user/tutorial/add_deploy.rstline 37 -
source/user/tutorial/add_fab.rstline 4 -
source/user/tutorial/add_reg_inst.rstline 42, 58 -
source/user/tutorial/data_explorer.rstlines 121, 124, 192, 231, missing figures -
source/user/tutorial/mod_rxtr.rstlines 35, 45 -
source/user/tutorial/run_cyclus_native.rstline 2 -
source/user/writing_input.rstline 65 -
source/arche/cmake.rstline 104
@abachma2 :
- Update the website with new version information.
- Reflect change of default branch to
main
@nuclearkatie
-
#365
-
Contributors list has not been updated any time recently
-
Last news update was Spring 2018
-
mbmore links point to Meghan's personal repo, when they are now managed and updated using this cnerg repo
-
Projects Using Cyclus currently only lists CVT (which doesn't exist anymore)
-
Copyright on the bottom of the website lists 2012-2016 and the license file lists 2010-2016
-
Cyclus Funding and Support is probably out of date
- it should probably at least list the NNSA through NA-22 (CTV, MTV) and NA-241 (NNIS fellowship)
-
If you click Next from the website home page, it takes you to a page called FY2016 NEUP Funding Opportunity with Cyclus. Not sure what else the next button should take you to, but this doesn't seem like the best choice now given how out of date it is
-
The website still lists a time and zoom link for Cyclus development calls
@abachma2 :
-
Do we want to keep a list of everyone that has contributed to the project? It's already outdated and while nice, maybe not as necessary now that the team is much larger
-
Fix link to Numpy contributing documentation to https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard in
source/numpydoc/numpydoc.pyline 15 -
Fix broken https://github3py.readthedocs.io/en/master/ link in
source/cep/cep6.rstline 87 to https://github3.readthedocs.io/en/latest/
@dean-krueger 👍
- Method to install setup.py in Python Archetype Development Tutorial is outdated. Switch to using pip
- Cyclus Inputs Tutorial instructs users to use "-" in names, Cyclus returns an error if this is done. Replace with "_"?
- #412
- Missing ">" in example input file for Adding a Separations Facility (Home >> CYCLUS User Guide >> CYCLUS User Tutorial >> Adding a Separations Facility) near the bottom of the file.
- C++ Tutorial "Hello World" has incorrect install instructions: the cycstub github page has different instructions and says that the method described on the tutorial page is "Depreciated" (#197, #366)
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from cyclus/cyclus.github.com
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
cyclus/cyclus.github.com#454 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 64/100
cyclus/cyclus.github.com#453 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
cyclus/cyclus.github.com#448 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
cyclus/cyclus.github.com#445 ·
-
[Task] Update tutorial files in Zenodo ObjectMay be free again @connor-welch claimed this 262 days ago, and no pull request is open. Open0 - Backlog
cyclus/cyclus.github.com#441 · 3 comments · 1 assignee ·
All issues in cyclus/cyclus.github.com
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
QuantEcon/lecture-python-programming#642 ·
Maintainers usually reply within 1 day
-
area/config area/profiles comp/cli needs-decision P3 sweeper:risk-compatibility type/feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
NousResearch/hermes-agent#133697 ·
Maintainers usually reply within 1 day
-
enhancement needs-triage
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
core
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
vectorize-io/hindsight#5279 ·
Maintainers usually reply within 1 day