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

Update README.md #362

Merged
merged 1 commit into from
Nov 22, 2024
+2 −2
Merged

Update README.md #362

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ Within the `notebooks` folder are examples of the API and workflows. These exam
+ perform quick visual checks and sanity checks of data
- examples of filtering data
+ lanzcos 35hr filter is most common
+ rolling median filter
+ RMSE filter

Within the `examples` and `notebooks` folders are a collection of examples, they may be exceptionally verbose or _simple_. The _simple_ examples can be used as a basis for developing "scripts" to archive for historical record, regarding the treatment of each instrument as it is analyzed. Alternatively, one could save any notebook to the archive or export an html or pdf version for historic records.

Expand All @@ -59,8 +61,6 @@ Found in the ci/requirements.txt

## Installing

### conda (TODO)

### pip

may be best to create a seperate environment and install packages via the requirements.txt first then install the software.
Expand Down