lasp / lasp/space_packet_parser
Add Documentation of XTCE Parsing Benchmarking
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 39
- Forks
- 15
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 12
Description
One of the benchmarks we run is the parsing of a complex CTIM XTCE packet definition file. At one point this parsing took 12s and is now down to under 100ms and we want it to stay that way.
Add a discussion of this benchmarking to the Documentation Benchmarking section.
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 by locating the Documentation Benchmarking section and read its existing structure and examples. Add a discussion of the complex CTIM XTCE packet-definition parsing benchmark, including the improvement from 12 seconds to under 100 ms and the expectation that this performance should be maintained; the section should clearly document this benchmark when done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100