please document _rlnHelicalTubeID as _ibIceGroup

Open
#12 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Compare README.md with the linked comment at src/icebreaker/star_appender.py#L36 and check the README’s settings-loading instructions. Done means the README documents the _rlnHelicalTubeID/_ibIceGroup header relationship and uses .gui_externaljob.star for the Relion GUI template.

Written by the indexing model from the issue text.

Description

Please update the README to reflect that the header tag with the ice breaker score when using ib_job.py is
in stored in _rlnHelicalTubeID

the only reference to this is in comment in the file blow

https://github.com/DiamondLightSource/python-icebreaker/blob/master/README.md

https://github.com/DiamondLightSource/python-icebreaker/blob/0fa6e1af5ee3f5a6d00fe5cd37da60fe65127953/src/icebreaker/star_appender.py#L36

Please also update the loading of settings

Copy one of the templates to your Relion project directory as .gui_externaljob.py

this needs to be called .gui_externaljob.star to be loaded correctly into the relion gui

Dominant language
Python
Stars
11
Forks
6
No merged PRs in 30d

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.

More from DiamondLightSource/python-icebreaker

All issues in DiamondLightSource/python-icebreaker

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.