Severson-Group / Severson-Group/docs.amdc.dev

Add example of data filtering to Logging docs

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

Nobody has claimed this yet.

help wanted
Dominant language
Jupyter Notebook
Stars
1
Forks
3
Avg merge
2d 23h
Merged PRs (30d)
1

Description

This issue was moved from the AMDC-Firmware repo: https://github.com/Severson-Group/AMDC-Firmware/issues/144


Per @Nick-Hemenway

You can VERY easily filter data in python pandas as follows:

First, create a filtering function:

# If the window length is 21, it will fit 10 data points to each side of the data point that is being smoothed
from scipy import signal
my_filter = lambda x: signal.savgol_filter(x, window_length = 21, polyorder = 2)

Then, to use the filter:
image

TODO

Since this is so easy and could be a very common thing to do when logging data, add a section to the Logging markdown docs with the above information.

Contributor guide

Open the contributing guide

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

Find the Logging markdown documentation in the docs.amdc.dev repository and review its existing data-logging examples. Add a section using the provided pandas and Savitzky-Golay filtering example, then verify that the documentation builds and the new section renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
pandas, python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.