Skip to content

Commit 6332f6f

Browse files
committed
fixed broken links in the readme
1 parent de64902 commit 6332f6f

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Python methods for numerical differentiation of noisy data, including multi-obje
3131
- [Prerequisite](#prerequisite)
3232
- [Installing](#installing)
3333
- [Usage](#usage)
34-
- [Basic usages](#basic-usages)
34+
- [Code snippets](#code-snippets)
3535
- [Notebook examples](#notebook-examples)
3636
- [Important notes](#important-notes)
3737
- [Running the tests](#running-the-tests)
@@ -97,7 +97,7 @@ See CITATION.cff file as well as the following references.
9797

9898
### Prerequisite
9999

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)
101101

102102
In addition, it also requires certain additional packages for select functions, though these are not required for a successful install of PyNumDiff:
103103
- Total Variation Regularization methods: [`cvxpy`](http://www.cvxpy.org/install/index.html)
@@ -118,7 +118,7 @@ Call `pip install pynumdiff[advanced]` to automatically install [CVXPY](https://
118118
**PyNumDiff** uses [Sphinx](http://www.sphinx-doc.org/en/stable/) for code documentation.
119119
So you can see more details about the API usage [there](https://pynumdiff.readthedocs.io/en/latest/).
120120

121-
### Basic usages
121+
### Code snippets
122122

123123
* Basic Usage: you provide the parameters
124124
```python
@@ -134,7 +134,7 @@ So you can see more details about the API usage [there](https://pynumdiff.readth
134134
tvgamma=tvgamma, # hyperparameter, defaults to None if dxdt_truth given
135135
dxdt_truth=None) # or give ground truth data, in which case tvgamma unused
136136
print('Optimal parameters: ', params)
137-
x_hat, dxdt_hat = method(x, dt, **params)`
137+
x_hat, dxdt_hat = method(x, dt, **params)
138138
```
139139
* Advanced usage: automated parameter selection through multi-objective optimization using a user-defined cutoff frequency
140140
```python
@@ -145,15 +145,15 @@ So you can see more details about the API usage [there](https://pynumdiff.readth
145145
params, val = optimize(method, x, dt, search_space={'param1':[options], 'param2':[options], ...},
146146
tvgamma=tvgamma)
147147
print('Optimal parameters: ', params)
148-
x_hat, dxdt_hat = method(x, dt, **params)`
148+
x_hat, dxdt_hat = method(x, dt, **params)
149149
```
150150

151151
### Notebook examples
152152

153153
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)
157157

158158
### Important notes
159159

@@ -175,5 +175,5 @@ Add the flag `--plot` to see plots of the methods against test functions. Add th
175175

176176
## License
177177

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).
179179
100% open-source, feel free to utilize the code however you like.

0 commit comments

Comments
 (0)