Skip to content

Commit

Permalink
Merge pull request #177 from sathvikbhagavan/sb/cleanup_readme
Browse files Browse the repository at this point in the history
docs: clean README.md and standardize similar to other SciML Repos
  • Loading branch information
ChrisRackauckas authored Sep 20, 2023
2 parents 242547d + 065a2b8 commit 1fa53e8
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
# DataInterpolations.jl

[![CI](https://github.com/PumasAI/DataInterpolations.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/PumasAI/DataInterpolations.jl/actions/workflows/CI.yml)
[![codecov](https://codecov.io/gh/PumasAI/DataInterpolations.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/PumasAI/DataInterpolations.jl)
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/DataInterpolations/stable/)

[![codecov](https://codecov.io/gh/SciML/DataInterpolations.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/SciML/DataInterpolations.jl)
[![CI](https://github.com/SciML/DataInterpolations.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/SciML/DataInterpolations.jl/actions/workflows/CI.yml)

[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)


DataInterpolations.jl is a library for performing interpolations of one-dimensional data. By
"data interpolations" we mean techniques for interpolating possibly noisy data, and thus
some methods are mixtures of regressions with interpolations (i.e. do not hit the data
points exactly, smoothing out the lines). This library can be used to fill in intermediate
data points in applications like timeseries data.

## Tutorial / Demonstration

A tutorial is included and can be found at [this page](https://htmlpreview.github.io/?https://github.com/PumasAI/DataInterpolations.jl/blob/v2.0.0/example/DataInterpolations.html). To run the tutorial yourself
locally, use the following Weave commands:

```julia
using Weave, DataInterpolations
weave(joinpath(dirname(pathof(DataInterpolations)), "../example", "DataInterpolations.jmd"), out_path=:doc)
```

## API

All interpolation objects act as functions. Thus for example, using an interpolation looks like:
Expand Down

0 comments on commit 1fa53e8

Please sign in to comment.