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.

Sign up for GitHub

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

Jump to bottom

Documentation #20

Open
wants to merge 23 commits into
base: dev
Choose a base branch
from
Open

Documentation #20

wants to merge 23 commits into from

Commits on Sep 5, 2024

  1. Updating calibration function for linear regression

    Gustavo committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    d807bf5 View commit details
    Browse the repository at this point in the history

  2. Added missing print statements

    Gustavo committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    b40db36 View commit details
    Browse the repository at this point in the history

Commits on Sep 17, 2024

  1. Changed calibration function to record magnetometer readings

    @danielkm-ee
    danielkm-ee committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    506f405 View commit details
    Browse the repository at this point in the history

  2. silly me, quick fix for parenthensis error

    @danielkm-ee
    danielkm-ee committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    f873590 View commit details
    Browse the repository at this point in the history

  3. fix operation error

    @danielkm-ee
    danielkm-ee committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    b44d746 View commit details
    Browse the repository at this point in the history

  4. Okay using enumerate in the for loops is the smarter way to do it.

    @danielkm-ee
    danielkm-ee committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    18345f9 View commit details
    Browse the repository at this point in the history

  5. added error checking into calibration script

    @danielkm-ee
    danielkm-ee committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    d8645a1 View commit details
    Browse the repository at this point in the history

  6. Added sign of magnetometer value

    @danielkm-ee
    danielkm-ee committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    8933ce7 View commit details
    Browse the repository at this point in the history

Commits on Sep 18, 2024

  1. Debug 1

    @danielkm-ee
    danielkm-ee committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    bf259a1 View commit details
    Browse the repository at this point in the history

Commits on Sep 20, 2024

  1. Updated function arguments and their defaults 

    Added constants `MAG_CURRENT_SLOPE` and `WMM_AMBIENT_FIELD` to use as default conversion factors
Added constant `MAX_OUT_CURRENT` used to limit the output current in set_field_vector()
    @danielkm-ee
    danielkm-ee committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    0814be3 View commit details
    Browse the repository at this point in the history

  2. Add Sphinx Documentation 

    Added quickstart files for Sphinx docs
Updated Standard Operating Procedure
    @danielkm-ee
    danielkm-ee committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    32ae3ce View commit details
    Browse the repository at this point in the history

  3. Move new content to img

    @danielkm-ee
    danielkm-ee committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    9523c81 View commit details
    Browse the repository at this point in the history

  4. Update SOP.md 

    Added helmholtz help page image
    @danielkm-ee
    danielkm-ee committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    b26ff64 View commit details
    Browse the repository at this point in the history

Commits on Sep 21, 2024

  1. Update Documentation 

    Added instructions to operate the cage program
Added instructions to compile the documentation to the README
    @danielkm-ee
    danielkm-ee committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    df9e891 View commit details
    Browse the repository at this point in the history

  2. Update README.md 

    Updated Photo of the Helmholtz Cage
    @danielkm-ee
    danielkm-ee committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    9caf062 View commit details
    Browse the repository at this point in the history

  3. Update README.md 

    Update photo again, it was way too big
    @danielkm-ee
    danielkm-ee committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    1bbab02 View commit details
    Browse the repository at this point in the history

  4. Update README.md 

    One more time!
    @danielkm-ee
    danielkm-ee committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    16088be View commit details
    Browse the repository at this point in the history

  5. Update README.md 

    Okay last time...
    @danielkm-ee
    danielkm-ee committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    19a2e6a View commit details
    Browse the repository at this point in the history

  6. Major update to add manpages for software docs 

    Added arduino.md, hshell.md, magmeter.md, powsups.md, utils.md, and manindex.rst to document HC controller
Updated index.rst to include new manpages
Updated README to provide sphinx installation directive
    @danielkm-ee
    danielkm-ee committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    989bd09 View commit details
    Browse the repository at this point in the history

  7. fix headers issue in manpages

    @danielkm-ee
    danielkm-ee committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    0de2e26 View commit details
    Browse the repository at this point in the history

  8. Major update filling out all function documentation 

    Added documentation for each function in arduino.md, hshell.md, magmeter.md, powsups.md, and utils.md
Updated manindex.rst
    @danielkm-ee
    danielkm-ee committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    ec7c3be View commit details
    Browse the repository at this point in the history

Commits on Sep 22, 2024

  1. Fix for sphinx documentation instructions

    @danielkm-ee
    danielkm-ee committed Sep 22, 2024
    Configuration menu
    Copy the full SHA
    488d6db View commit details
    Browse the repository at this point in the history

  2. Fix indentation mistake

    @danielkm-ee
    danielkm-ee committed Sep 22, 2024
    Configuration menu
    Copy the full SHA
    3169d94 View commit details
    Browse the repository at this point in the history