marl / marl/SpatialScaper

consolidate utilities

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

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
78
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Currently we have many similar core utilities floating around, such as:
- `deg2rad`
- `rad2deg`
- `unitvec_to_cartesian`
- `get_y`
and many other (mostly catesian operations), sometimes not even defined as functions and instead embedded within larger functions or scripts.

All of these should be broken-down into units that build on each other, consolidated in specific utilities files, documented, and tested.

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.

Research direction

Locate the existing implementations of deg2rad, rad2deg, unitvec_to_cartesian, get_y, and the other Cartesian operations across the project. First inventory where these utilities are defined or embedded, then determine the utility files, documentation, and tests needed so the operations are consolidated, composable, documented, and covered.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.