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

Conversation

danielkm-ee
Copy link

Documentation updates and other changes

  • Documentation is now setup to compile as a sphinx project which is viewable as HTML through a web browser
  • A great deal of documentation has been written in markdown including and updated SOP and manual pages for all functions in the helmholtz cage library
  • Updates have been made to the README which reflect the current status of the cage and demonstrate the compilation process for the Sphinx project, and viewing the documentation

image

Gustavo and others added 23 commits September 5, 2024 13:57
Updating calibration function for linear regression
d807bf5
Added missing print statements
b40db36
@danielkm-ee
Changed calibration function to record magnetometer readings
506f405
@danielkm-ee
silly me, quick fix for parenthensis error
f873590
@danielkm-ee
fix operation error
b44d746
@danielkm-ee
Okay using enumerate in the for loops is the smarter way to do it.
18345f9
@danielkm-ee
added error checking into calibration script
d8645a1
@danielkm-ee
Added sign of magnetometer value
8933ce7
@danielkm-ee
Debug 1
bf259a1
@danielkm-ee
Updated function arguments and their defaults
0814be3 
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
Add Sphinx Documentation
32ae3ce 
Added quickstart files for Sphinx docs
Updated Standard Operating Procedure
@danielkm-ee
Move new content to img
9523c81
@danielkm-ee
Update SOP.md
b26ff64 
Added helmholtz help page image
@danielkm-ee
Update Documentation
df9e891 
Added instructions to operate the cage program
Added instructions to compile the documentation to the README
@danielkm-ee
Update README.md
9caf062 
Updated Photo of the Helmholtz Cage
@danielkm-ee
Update README.md
1bbab02 
Update photo again, it was way too big
@danielkm-ee
Update README.md
16088be 
One more time!
@danielkm-ee
Update README.md
19a2e6a 
Okay last time...
@danielkm-ee
Major update to add manpages for software docs
989bd09 
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
fix headers issue in manpages
0de2e26
@danielkm-ee
Major update filling out all function documentation
ec7c3be 
Added documentation for each function in arduino.md, hshell.md, magmeter.md, powsups.md, and utils.md
Updated manindex.rst
@danielkm-ee
Fix for sphinx documentation instructions
488d6db
@danielkm-ee
Fix indentation mistake
3169d94
@danielkm-ee danielkm-ee self-assigned this Sep 25, 2024
@danielkm-ee
Copy link
Author

Updates that need to be made to Documentation:

  • Need to add documentation for new functions
    • receive_sim_data
    • run_sim
  • Update functions that changed
    • set_field_vector() : arguments have changed
    • calibration : function is changing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emilysnod emilysnod Awaiting requested review from emilysnod

@gcotom gcotom Awaiting requested review from gcotom

@andrewgreenberg andrewgreenberg Awaiting requested review from andrewgreenberg

Assignees

@danielkm-ee danielkm-ee

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@danielkm-ee