Update machine build documentation
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- Python
- Stars
- 71
- Forks
- 27
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 33
Description
machine-build.md has now gotten slightly out of date so it would be worthwhile updating the figures and some info.
The radial and vertical build plots from plot_proc.py could be added, also the poloidal cross section showing all the dimensions is now very out of date. It would probably be best to make a plotting script using the cross section from plot_proc.py and annotate it.
Contributor guide
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 with machine-build.md and inspect plot_proc.py to understand the existing radial and vertical build plots and the poloidal cross section. Update the outdated figures and information, add the requested plots, and ensure the annotated cross-section dimensions are current.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100