@@ -51,8 +51,10 @@ for more information.
51
51
Install standard release
52
52
------------------------
53
53
54
- To obtain the most recent stable release of pvlib-python, use
55
- `conda <http://conda.pydata.org/docs/ >`_ or `pip <https://pip.pypa.io >`_::
54
+ To obtain the most recent stable release of pvlib-python, use `conda
55
+ <http://conda.pydata.org/docs/> `_ (recommended if you use the Anaconda
56
+ Python distribution) or `pip <https://pip.pypa.io >`_ (works with any
57
+ Python distribution)::
56
58
57
59
conda install -c pvlib pvlib
58
60
@@ -67,10 +69,11 @@ You may still want to download the Python source code so that you can
67
69
easily get all of the Jupyter Notebook tutorials. Either clone the `git
68
70
repository <https://github.com/pvlib/pvlib-python> `_ or go to the
69
71
`Releases page <https://github.com/pvlib/pvlib-python/releases >`_ to
70
- download the zip file of the most recent release. You can also use
71
- the nbviewer website to choose a tutorial to experiment with.
72
- Go to our `nbviewer tutorial page
73
- <http://nbviewer.jupyter.org/github/pvlib/pvlib-python/tree/master/docs/tutorials/> `_
72
+ download the zip file of the most recent release. You can also use the
73
+ nbviewer website to choose a tutorial to experiment with. Go to our
74
+ `nbviewer tutorial page
75
+ <http://nbviewer.jupyter.org/github/pvlib/pvlib-python/tree/master/docs/
76
+ tutorials/> `_.
74
77
75
78
76
79
.. _editablelibrary :
@@ -95,16 +98,16 @@ You'll get there.
95
98
Obtain the source code
96
99
~~~~~~~~~~~~~~~~~~~~~~
97
100
98
- We will describe how to obtain the pvlib-python source code using
99
- the git/GitHub version control system. We encourage users to learn
100
- how to use these powerful tools, but we also recognize that they
101
- can be a substantial roadblock to getting started with pvlib-python.
102
- Therefore, you should know that you can download a zip file of
103
- the most recent development version of the source code by
104
- clicking on the **Download Zip ** button on the right side of our
105
- `GitHub page <https://github.com/pvlib/pvlib-python >`_
106
- or download a zip file of any stable release from our
107
- ` Releases page <https://github.com/pvlib/pvlib-python/releases >`_.
101
+ We will briefly describe how to obtain the pvlib-python source code
102
+ using the git/GitHub version control system. We strongly encourage users
103
+ to learn how to use these powerful tools (see the :ref: ` references `!),
104
+ but we also recognize that they can be a substantial roadblock to
105
+ getting started with pvlib-python. Therefore, you should know that you
106
+ can download a zip file of the most recent development version of the
107
+ source code by clicking on the **Download Zip ** button on the right side
108
+ of our `GitHub page <https://github.com/pvlib/pvlib-python >`_ or
109
+ download a zip file of any stable release from our ` Releases page
110
+ <https://github.com/pvlib/pvlib-python/releases> `_.
108
111
109
112
Follow these steps to obtain the library using git/GitHub:
110
113
@@ -114,13 +117,15 @@ Follow these steps to obtain the library using git/GitHub:
114
117
`pvlib-python GitHub page <https://github.com/pvlib/pvlib-python >`_.
115
118
#. **Clone ** your fork to your computer using the GitHub Desktop application
116
119
by clicking on the *Clone to Desktop * button on your fork's homepage.
117
- This button is circled in the image below.
120
+ This button is circled in the image below. Remember the system path that
121
+ you clone the library to.
118
122
119
123
.. image :: _images/clonebutton.png
120
124
121
125
Please see GitHub's
122
- `Forking Projects <https://guides.github.com/activities/forking/ >`_ and
123
- `Fork A Repo <https://help.github.com/articles/fork-a-repo/ >`_ for
126
+ `Forking Projects <https://guides.github.com/activities/forking/ >`_,
127
+ `Fork A Repo <https://help.github.com/articles/fork-a-repo/ >`_,
128
+ and the `git-scm <https://git-scm.com/documentation >`_ for
124
129
more details.
125
130
126
131
.. _setupenvironment :
@@ -160,12 +165,32 @@ Install the source code
160
165
~~~~~~~~~~~~~~~~~~~~~~~
161
166
162
167
Good news -- installing the source code is the easiest part!
168
+ With your conda/virtual environment still active...
163
169
164
- #. In your terminal or shell, **navigate ** to the top-level
165
- pvlib-python directory.
166
170
#. **Install ** pvlib-python in "development mode" by running
167
- ``pip install -e . ``
168
-
171
+ ``pip install -e /path/to/your/pvlib-python ``.
172
+ You remember this path from the clone step, right? It's probably
173
+ something like ``C:\Users\%USER%\Documents\GitHub\pvlib-python ``
174
+ (Windows) or ``/Users/%USER%/Documents/pvlib-python `` (Mac).
175
+ #. **Test ** your installation by running ``python -c 'import pvlib' ``.
176
+ You're good to go if it returns without an exception.
177
+
178
+ The version of pvlib-python that is on that path is now available
179
+ as an installed package inside your conda/virtual environment.
180
+
181
+ Any changes that you make to this pvlib-python will be available inside
182
+ your environment. If you run a git checkout, branch, or pull command the
183
+ result will be applied to your pvlib-python installation. This
184
+ is great for development. Note, however, that you will need to use
185
+ Python's ``reload `` function (`python 2
186
+ <https://docs.python.org/2/library/functions.html#reload> `_, `python 3
187
+ <https://docs.python.org/3/library/importlib.html#importlib.reload> `_)
188
+ if you make changes to pvlib during an interactive Python
189
+ session (including a Jupyter notebook). Restarting the Python
190
+ interpreter will also work.
191
+
192
+ Remember to ``source activate pvlibdev `` (or whatever you named your
193
+ environment) when you start a new shell or terminal.
169
194
170
195
.. _references :
171
196
@@ -183,3 +208,14 @@ Here are a few recommended references for installing Python packages:
183
208
* `Conda User Guide
184
209
<http://conda.pydata.org/docs/index.html> `_
185
210
211
+ Here are a few recommended references for git and GitHub:
212
+
213
+ * `The git documentation <https://git-scm.com/doc >`_:
214
+ detailed explanations, videos, more links, and cheat sheets. Go here first!
215
+ * `Forking Projects <https://guides.github.com/activities/forking/ >`_
216
+ * `Fork A Repo <https://help.github.com/articles/fork-a-repo/ >`_
217
+ * `Cloning a repository
218
+ <https://help.github.com/articles/cloning-a-repository/> `_
219
+ * `Aha! Moments When Learning Git
220
+ <http://betterexplained.com/articles/aha-moments-when-learning-git/> `_
221
+
0 commit comments