Skip to content

Commit 70f75dc

Browse files
authored
Merge pull request #575 from bashtage/remove-redundant-import
MAINT: Clean markdown
2 parents 1bfd184 + 78deedd commit 70f75dc

File tree

2 files changed

+28
-27
lines changed

2 files changed

+28
-27
lines changed

LICENSE.md

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
1+
# License
2+
13
**Copyright (c) 2017 Kevin Sheppard. All rights reserved.**
24

35
Developed by: Kevin Sheppard (<[email protected]>,
46
57
[https://www.kevinsheppard.com](https://www.kevinsheppard.com)
68

7-
Permission is hereby granted, free of charge, to any person obtaining a copy of
8-
this software and associated documentation files (the "Software"), to deal with
9-
the Software without restriction, including without limitation the rights to
10-
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
11-
of the Software, and to permit persons to whom the Software is furnished to do
9+
Permission is hereby granted, free of charge, to any person obtaining a copy of
10+
this software and associated documentation files (the "Software"), to deal with
11+
the Software without restriction, including without limitation the rights to
12+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
13+
of the Software, and to permit persons to whom the Software is furnished to do
1214
so, subject to the following conditions:
1315

14-
Redistributions of source code must retain the above copyright notice, this
16+
Redistributions of source code must retain the above copyright notice, this
1517
list of conditions and the following disclaimers.
1618

17-
Redistributions in binary form must reproduce the above copyright notice, this
18-
list of conditions and the following disclaimers in the documentation and/or
19+
Redistributions in binary form must reproduce the above copyright notice, this
20+
list of conditions and the following disclaimers in the documentation and/or
1921
other materials provided with the distribution.
2022

21-
Neither the names of Kevin Sheppard, nor the names of its contributors may be
22-
used to endorse or promote products derived from this Software without specific
23+
Neither the names of Kevin Sheppard, nor the names of its contributors may be
24+
used to endorse or promote products derived from this Software without specific
2325
prior written permission.
2426

25-
**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28-
CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH
31-
THE SOFTWARE.**
27+
**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
30+
CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
31+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
32+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH
33+
THE SOFTWARE.**

README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ to improve performance)
99
| Metric | |
1010
| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1111
| **Latest Release** | [![PyPI version](https://badge.fury.io/py/arch.svg)](https://badge.fury.io/py/arch) |
12-
| | [![conda-forge version](https://anaconda.org/conda-forge/arch-py/badges/version.svg)](https://anaconda.org/conda-forge/arch-py) |
12+
| | [![conda-forge version](https://anaconda.org/conda-forge/arch-py/badges/version.svg)](https://anaconda.org/conda-forge/arch-py) |
1313
| **Continuous Integration** | [![Build Status](https://dev.azure.com/kevinksheppard0207/kevinksheppard/_apis/build/status/bashtage.arch?branchName=main)](https://dev.azure.com/kevinksheppard0207/kevinksheppard/_build/latest?definitionId=1&branchName=main) |
1414
| | [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/nmt02u7jwcgx7i2x?svg=true)](https://ci.appveyor.com/project/bashtage/arch/branch/main) |
1515
| **Coverage** | [![codecov](https://codecov.io/gh/bashtage/arch/branch/main/graph/badge.svg)](https://codecov.io/gh/bashtage/arch) |
@@ -18,7 +18,7 @@ to improve performance)
1818
| | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/93f6fd90209842bf97fd20fda8db70ef)](https://www.codacy.com/manual/bashtage/arch?utm_source=github.com&utm_medium=referral&utm_content=bashtage/arch&utm_campaign=Badge_Grade) |
1919
| | [![codebeat badge](https://codebeat.co/badges/18a78c15-d74b-4820-b56d-72f7e4087532)](https://codebeat.co/projects/github-com-bashtage-arch-main) |
2020
| **Citation** | [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.593254.svg)](https://doi.org/10.5281/zenodo.593254) |
21-
| **Documentation** | [![Documentation Status](https://readthedocs.org/projects/arch/badge/?version=latest)](https://arch.readthedocs.org/en/latest/) |
21+
| **Documentation** | [![Documentation Status](https://readthedocs.org/projects/arch/badge/?version=latest)](https://arch.readthedocs.org/en/latest/) |
2222

2323
## Module Contents
2424

@@ -114,7 +114,7 @@ for examples of testing series for unit roots.
114114
- Engle-Granger Test
115115
- Phillips-Ouliaris Test
116116
- Cointegration Vector Estimation
117-
- Canonical Cointegrating Regression
117+
- Canonical Cointegrating Regression
118118
- Dynamic OLS
119119
- Fully Modified OLS
120120

@@ -170,21 +170,20 @@ ci = bs.conf_int(sharpe_ratio, 1000, method='percentile')
170170
### Multiple Comparison Procedures
171171

172172
- Test of Superior Predictive Ability (SPA), also known as the Reality
173-
Check or Bootstrap Data Snooper
173+
Check or Bootstrap Data Snooper
174174
- Stepwise (StepM)
175175
- Model Confidence Set (MCS)
176176

177177
See the [multiple comparison example notebook](https://nbviewer.ipython.org/github/bashtage/arch/blob/main/examples/multiple-comparison_examples.ipynb)
178178
for examples of the multiple comparison procedures.
179179

180-
181180
<a id="long-run-covariance"></a>
182181

183182
### Long-run Covariance Estimation
184183

185184
Kernel-based estimators of long-run covariance including the
186185
Bartlett kernel which is known as Newey-West in econometrics.
187-
Automatic bandwidth selection is available for all of the
186+
Automatic bandwidth selection is available for all of the
188187
covariance estimators.
189188

190189
```python
@@ -213,8 +212,8 @@ that arch will work with older versions.
213212

214213
### Optional Requirements
215214

216-
- Numba (0.49+) will be used if available **and** when installed without building the binary modules. In order to ensure that these are not built, you must set the environment variable ``ARCH_NO_BINARY=1`` and install without the wheel.
217-
215+
- Numba (0.49+) will be used if available **and** when installed without building the binary modules. In order to ensure that these are not built, you must set the environment variable `ARCH_NO_BINARY=1` and install without the wheel.
216+
218217
```shell
219218
export ARCH_NO_BINARY=1
220219
python -m pip install arch
@@ -283,6 +282,6 @@ The development requirements are:
283282
### Installation Notes
284283

285284
1. If Cython is not installed, the package will be installed
286-
as-if `ARCH_NO_BINARY=1` was set.
285+
as-if `ARCH_NO_BINARY=1` was set.
287286
2. Setup does not verify these requirements. Please ensure these are
288-
installed.
287+
installed.

0 commit comments

Comments
 (0)