Starfish-develop / Starfish-develop/Starfish
Basic examples don't run
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 78
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
Trying to follow http://iancze.github.io/Starfish/current/example_wasp14.html :
When I use the 20-line example "YAML" file listed in "Just getting set up," and run "star.py --run_index 1", I get errors like
"KeyError: 'parname' "... because (I think) there is no 'parname' field in that 20-line example. From looking at other parts of the online documentation I was able to fill in some of the gaps, but am stuck at "KeyError: 'Phi'" because I'm not sure how "Phi" should be set.
So: it seems like the example YAML is missing key lines, preventing even this first, simplest example from running.
Contributor guide
No contributing guide indexed for this repository
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 the linked example_wasp14.html page and its “Just getting set up” section, then run the documented star.py --run_index 1 command using the example YAML. Trace the reported parname and Phi errors to determine the missing example configuration. Done means the minimal example runs without these KeyErrors and the documentation contains the required settings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100