You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Python methods for numerical differentiation of noisy data, including multi-obje
31
31
-[Prerequisite](#prerequisite)
32
32
-[Installing](#installing)
33
33
-[Usage](#usage)
34
-
-[Basic usages](#basic-usages)
34
+
-[Code snippets](#code-snippets)
35
35
-[Notebook examples](#notebook-examples)
36
36
-[Important notes](#important-notes)
37
37
-[Running the tests](#running-the-tests)
@@ -97,7 +97,7 @@ See CITATION.cff file as well as the following references.
97
97
98
98
### Prerequisite
99
99
100
-
PyNumDiff requires common packages like `numpy`, `scipy`, and `matplotlib`. For a full list, you can check the file [pyproject.toml](pyproject.toml)
100
+
PyNumDiff requires common packages like `numpy`, `scipy`, and `matplotlib`. For a full list, you can check the file [pyproject.toml](https://github.com/florisvb/PyNumDiff/blob/master/pyproject.toml)
101
101
102
102
In addition, it also requires certain additional packages for select functions, though these are not required for a successful install of PyNumDiff:
103
103
- Total Variation Regularization methods: [`cvxpy`](http://www.cvxpy.org/install/index.html)
**PyNumDiff** uses [Sphinx](http://www.sphinx-doc.org/en/stable/) for code documentation.
119
119
So you can see more details about the API usage [there](https://pynumdiff.readthedocs.io/en/latest/).
120
120
121
-
### Basic usages
121
+
### Code snippets
122
122
123
123
* Basic Usage: you provide the parameters
124
124
```python
@@ -134,7 +134,7 @@ So you can see more details about the API usage [there](https://pynumdiff.readth
134
134
tvgamma=tvgamma, # hyperparameter, defaults to None if dxdt_truth given
135
135
dxdt_truth=None) # or give ground truth data, in which case tvgamma unused
136
136
print('Optimal parameters: ', params)
137
-
x_hat, dxdt_hat = method(x, dt, **params)`
137
+
x_hat, dxdt_hat = method(x, dt, **params)
138
138
```
139
139
* Advanced usage: automated parameter selection through multi-objective optimization using a user-defined cutoff frequency
140
140
```python
@@ -145,15 +145,15 @@ So you can see more details about the API usage [there](https://pynumdiff.readth
145
145
params, val = optimize(method, x, dt, search_space={'param1':[options], 'param2':[options], ...},
146
146
tvgamma=tvgamma)
147
147
print('Optimal parameters: ', params)
148
-
x_hat, dxdt_hat = method(x, dt, **params)`
148
+
x_hat, dxdt_hat = method(x, dt, **params)
149
149
```
150
150
151
151
### Notebook examples
152
152
153
153
We will frequently update simple examples for demo purposes, and here are currently exisiting ones:
154
-
* Differentiation with different methods: [1_basic_tutorial.ipynb](examples/1_basic_tutorial.ipynb)
155
-
* Parameter Optimization with known ground truth (only for demonstration purpose): [2a_optimizing_parameters_with_dxdt_known.ipynb](examples/2a_optimizing_parameters_with_dxdt_known.ipynb)
156
-
* Parameter Optimization with unknown ground truth: [2b_optimizing_parameters_with_dxdt_unknown.ipynb](./examples/2b_optimizing_parameters_with_dxdt_unknown.ipynb)
154
+
* Differentiation with different methods: [1_basic_tutorial.ipynb](https://github.com/florisvb/PyNumDiff/blob/master/examples/1_basic_tutorial.ipynb)
155
+
* Parameter Optimization with known ground truth (only for demonstration purpose): [2a_optimizing_parameters_with_dxdt_known.ipynb](https://github.com/florisvb/PyNumDiff/blob/master/examples/2a_optimizing_parameters_with_dxdt_known.ipynb)
156
+
* Parameter Optimization with unknown ground truth: [2b_optimizing_parameters_with_dxdt_unknown.ipynb](https://github.com/florisvb/PyNumDiff/blob/master/examples/2b_optimizing_parameters_with_dxdt_unknown.ipynb)
157
157
158
158
### Important notes
159
159
@@ -175,5 +175,5 @@ Add the flag `--plot` to see plots of the methods against test functions. Add th
175
175
176
176
## License
177
177
178
-
This project utilizes the [MIT LICENSE](LICENSE.txt).
178
+
This project utilizes the [MIT LICENSE](https://github.com/florisvb/PyNumDiff/blob/master/LICENSE.txt).
179
179
100% open-source, feel free to utilize the code however you like.
0 commit comments