pcdshub / pcdshub/hutch-python
Experiment Specific Documentation
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 1
- Forks
- 18
- Avg merge
- 7d 9h
- Merged PRs (30d)
- 1
Description
Expected Behavior
We often write an ELog post about the devices we have loaded in the Experiment folder as well as a brief description of any special scans and how to use them. It would be nice if all this could simply be written in the experiment file itself then published or at least built somewhere convenient.
Suggested by @koglin
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 by reviewing how experiment files are currently loaded and how ELog posts are produced. Define where device and special-scan documentation should live in an experiment file and where the published or built output should appear. Done means the workflow and output location are clear and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100