search

MazinLab / MKIDGen3

GNU General Public License v3.0
8 stars 3 forks source link

Clean up the repository and enable easier installation #25

Closed ld-cd closed 8 months ago

ld-cd commented 8 months ago

This PR is a big bundle of things, but each commit should be relatively self contained and can be cherry picked in if there are changes that need to be made to the PR overall.

Broadly this removes pieces of the repository that have gone stale and updates the python package to use the current standard python packaging metadata. This should make things like adding sphinx docs relatively straightforward and the correct dependency listing makes the client code pip installable.

The board side code is also pip installable with the exception of xrfdc and xrfclk packages but will check if they are installed, we may want to vendor these since we patch both of them anyways.

Fixes #14

ld-cd commented 8 months ago

Will do

ld-cd commented 8 months ago

Looking pretty good so far. Thanks for working on this. Can you add some install instructions in docs or the README? I will test and then approve.

Done

ld-cd commented 8 months ago

Will add a note about that in the README.md, highly tempted to just package xrfdc and xrfclk on pypi

ld-cd commented 8 months ago

(Don't merge this yet, I'm gonna do some rebasing so the history looks sane)

ld-cd commented 8 months ago

I think we are ready to merge this, is that alright @JennySmith888