Skip to content

Commit f07f069

Browse files
authored
docs: astropy package is automatically installed as dependency, no manual installation required (#21)
* docs: astropy package is automatically installed as dependency, no manual installation required * chore: fix permissions * chore: bump python packages * chore: bump deps * chore: bump deps
1 parent db06276 commit f07f069

7 files changed

Lines changed: 1163 additions & 1113 deletions

File tree

docs/enhancements.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,7 @@ keywords: ["data processing", "data refinement", "second derivative", "laplacian
55
---
66

77
Sometimes our spectra are not well resolved. In such cases, we may perform some
8-
post processing to enhance the spectral features. You will need [astropy](
9-
https://docs.astropy.org/en/latest/api/astropy.convolution.Box2DKernel.html)
10-
module to be installed:
11-
```bash
12-
pip install astropy
13-
```
8+
post processing to enhance the spectral features.
149

1510
:::caution
1611

@@ -20,7 +15,7 @@ https://github.com/zhangpengphi/curvature) implemented by Prof. P. Zhang.
2015

2116
:::
2217

23-
Here is our original data:
18+
Here is how the original data looks like:
2419

2520
```python showLineNumbers
2621
url = 'https://pranabdas.github.io/drive/datasets/arpes/sample_spectrum.txt'
@@ -37,14 +32,15 @@ plt.show()
3732
![plot-sample-spectra](../static/img/plot-sample-spectra.webp)
3833

3934
## Laplacian
40-
We can take the double derivative of the spectra in order to enhance the edges:
35+
We can take the double derivative of the spectra in order to enhance the
36+
spectral features:
4137

4238
$$
4339
I' = \frac{\partial^2 I}{\partial x^2} + w^2 \frac{\partial^2 I}{\partial y^2}
4440
$$
4541

46-
Since the $x$ and $y$ scales represent different quantities (units), we also
47-
have a weight factor $w$.
42+
Since the $x$ and $y$ scales represent different quantities (units), we have a
43+
weight factor $w$ to account for this.
4844

4945
```python showLineNumbers
5046
# diff2 = arp.laplacian(data, x, y, bw=5, w=1)

docs/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Glossary
33
---
44

5-
Full list of **arpespythontools** modules/ routines in alphabetical order:
5+
Full list of **arpespythontools** modules/<wbr/>routines in alphabetical order:
66

77
```python
88
import arpespythontools as arp

0 commit comments

Comments
 (0)