Document use cases for scopes and modes
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 52/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
No file or test is named. Start by locating the existing scope and mode examples and the source or configuration used to generate the documentation. Add the additional hostname, subject_id, and topology use cases with clear scope-design patterns, then verify they appear in the generated docs.
Written by the indexing model from the issue text.
Description
Understanding scopes is kind of hard, so we should write down as many slightly different use cases we can think of to provide a reference of ficus scope-design patterns. Here's a few, but we should have more, and nicely include them in generated docs.
1. One software running on multiple computers
One scope: hostname to have different settings based on computer, for instance
- hard drive locations (save your data to E drive)
- peripheral COM ports that are different on every computer.
2. SW running on multiple computers, mouse-specific overrides.
Two scopes: hostname and subject_id
Mouse-specific overrides could be something like stage position.
3. Instrument SW running on different computers with different topologies
Fancy multicomponent thing like prototome, that is composed of 1 microtome plus 0-2 lassos
Two scopes: hostname and topology
Where topology can be {no_lasso, one_lasso, two_lasso}
- Dominant language
- Python
- Stars
- 1
- Forks
- 0
- Avg merge
- 5d 19h
- Merged PRs (30d)
- 4
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- No contributing 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.
More from AllenNeuralDynamics/ficus
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
AllenNeuralDynamics/ficus#87 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
AllenNeuralDynamics/ficus#85 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
AllenNeuralDynamics/ficus#84 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
AllenNeuralDynamics/ficus#54 · 4 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
AllenNeuralDynamics/ficus#93 · 2 comments ·
All issues in AllenNeuralDynamics/ficus
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
NousResearch/hermes-agent#140958 ·
Maintainers usually reply within 1 day
-
Bisect issue233186Openbisect
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
dtcxzyw/llvm-bisect-service#548 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
sallowayma-git/IELTS-practice#248 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
anthropics/claude-plugins-official#6763 · 10 comments · 10 reactions ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day