Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor to create a AfidSet class #14

Merged
merged 18 commits into from
Aug 24, 2023
Merged

Commits on Aug 22, 2023

  1. refactor to create a class for afids

    An `afids.py` file has been added in order to create an AFIDSet dict
    class, enabling the storing of both metadata information, well as
    loading fiducials from files directly into a dataframe. The choice of
    using a dataframe here is for easier downstream manipulation.
    
      - `get_afid` has been moved into here as a method of the AfidSet class
    
    Moved extension specific file handling into its own `.py` files (e.g.
    `extensions/fcsv.py`). This choice was made to simplify the maintenance of handling
    different file extensions.
    
      - Separate semi-private methods are used for grabbing the metadata, as
    well as loading the fiducials into a polars dataframe.
    
    Additionally `io.py` has been refactored to
    generalize the handling of different file types (calling the methods
    within the different `extensions`).
    
    Updates poetry.lock and pyproject.toml to include the `attrs` library
    kaitj committed Aug 22, 2023
    Configuration menu
    Copy the full SHA
    6defa80 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ddaea1b View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    8c7dfee View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    485314e View commit details
    Browse the repository at this point in the history
  5. change saving to use AfidSet

    kaitj committed Aug 22, 2023
    Configuration menu
    Copy the full SHA
    af9a15a View commit details
    Browse the repository at this point in the history
  6. update code coverage

    kaitj committed Aug 22, 2023
    Configuration menu
    Copy the full SHA
    f8c2299 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    df85426 View commit details
    Browse the repository at this point in the history

Commits on Aug 23, 2023

  1. Configuration menu
    Copy the full SHA
    bef365d View commit details
    Browse the repository at this point in the history
  2. update doc requirements

    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    29cdcef View commit details
    Browse the repository at this point in the history
  3. update attr -> attrs

    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    7cb62be View commit details
    Browse the repository at this point in the history
  4. drop polars from dependency

    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    8c51097 View commit details
    Browse the repository at this point in the history
  5. partially tkkuehn comments

    - Remove `io.py`, moving methods to the AfidSet class. `load` is now a ClassMethod while `save` is a method of the instance.
    - Added an `AfidPosition` class, which is now used to store AFIDs
    - Drops polars from use, favouring `List[AfidPosition]` instead
    - Update mismatched desc in template.fcsv
    - Update strategies.py to generate coords using `AfidPosition`
    - Update all tests to correspond with changes made
    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    488abd5 View commit details
    Browse the repository at this point in the history
  6. update codecov components

    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    6001c00 View commit details
    Browse the repository at this point in the history
  7. update doc's toctree

    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    c3fa441 View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    e5e83cd View commit details
    Browse the repository at this point in the history
  9. add exceptions to the docs

    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    6fa2177 View commit details
    Browse the repository at this point in the history
  10. linting / formatting updates

    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    edd92be View commit details
    Browse the repository at this point in the history
  11. fix doc rst eval

    kaitj committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    e13eebd View commit details
    Browse the repository at this point in the history