Skip to content

Commit 30f456b

Browse files
committed
fix readme typos
1 parent bec5518 commit 30f456b

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

pvlib/spa_c_files/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
README
22
------
33

4-
NREL provides a fast C implementation of the solar position algorithm
4+
NREL provides a C implementation of the solar position algorithm
55
described in
6-
(Reda, I.; Andreas, A. (2003). Solar Position Algorithm for Solar Radiation Applications. 55 pp.; NREL Report No. TP-560-34302)
7-
[http://www.nrel.gov/docs/fy08osti/34302.pdf].
6+
[Reda, I.; Andreas, A. (2003). Solar Position Algorithm for Solar Radiation Applications. 55 pp.; NREL Report No. TP-560-34302](
7+
http://www.nrel.gov/docs/fy08osti/34302.pdf).
88

99
This folder contains the files required to make NREL's C code accessible
10-
to the pvlib-python package. We use the Cython package to wrap the NREL SPA
11-
algorithm.
10+
to the ``pvlib-python`` package. We use the Cython package to wrap NREL's SPA
11+
implementation.
1212

13-
** Due to license issues, you must download the NREL C files from their
14-
(website)[http://www.nrel.gov/midc/spa/#register] **
13+
** Due to licensing issues, you must download the NREL C files from their
14+
[website](http://www.nrel.gov/midc/spa) **
1515

1616
Download the ``spa.c`` and ``spa.h`` files from NREL,
1717
and copy them into the ``pvlib/spa_c_files`` directory.
@@ -20,7 +20,7 @@ There are a total of 5 files needed to compile the C code, described below:
2020

2121
* ``spa.c``: original C code from NREL
2222
* ``spa.h``: header file for spa.c
23-
* ``cspa_py.pxd``: a cython header file- essentially tells cython which parts of the main header file to pay attention to
23+
* ``cspa_py.pxd``: a cython header file which essentially tells cython which parts of the main header file to pay attention to
2424
* ``spa_py.pyx``: the cython code used to define both functions in the python namespace. NOTE: It is possible to provide user access to other paramters of the SPA algorithm through modifying this file
2525
* ``setup.py``: a distutils file which performs the compiling of the cython code
2626

@@ -32,4 +32,3 @@ To process the original 5 files,
3232
use the following shell command inside this folder
3333

3434
$ python setup.py build_ext --inplace
35-

0 commit comments

Comments
 (0)