@@ -85,9 +85,9 @@ Finally, to install pysteps and all its dependencies run::
85
85
Install from source
86
86
-------------------
87
87
88
- The recommended way to install pysteps from the source is using `pip `
89
- to adhere to the [ PEP517 standards]( https://www.python.org/dev/peps/pep-0517/) .
90
- Using `pip ` instead of `setup.py ` guarantees that all the package dependencies
88
+ The recommended way to install pysteps from the source is using `` pip ` `
89
+ to adhere to the ` PEP517 standards < https://www.python.org/dev/peps/pep-0517/ >`_ .
90
+ Using `` pip `` instead of `` setup.py ` ` guarantees that all the package dependencies
91
91
are properly handled during the installation process.
92
92
93
93
.. _install_osx_users :
@@ -151,15 +151,19 @@ Or, from a local copy of the repo::
151
151
The above commands install the latest version of the **master ** branch,
152
152
which is continuously under development.
153
153
154
+ .. warning ::
155
+ If you are installing pysteps from the sources using pip, the Python interpreter must be launched outside of the pysteps root directory.
156
+ Importing pysteps from a working directory that contains the pysteps source code will raise a ``ModuleNotFoundError ``.
157
+ This error is caused by the root pysteps folder being recognized as the pysteps package, also known as
158
+ `the double import trap <http://python-notes.curiousefficiency.org/en/latest/python_concepts/import_traps.html#the-double-import-trap >`_.
159
+
154
160
Setting up the user-defined configuration file
155
161
----------------------------------------------
156
162
157
- .. _JSON : https://en.wikipedia.org/wiki/JSON
158
-
159
163
The pysteps package allows the users to customize the default settings
160
164
and configuration.
161
165
The configuration parameters used by default are loaded from a user-defined
162
- JSON _ file and then stored in the **pysteps.rcparams **, a dictionary-like object
166
+ ` JSON < https://en.wikipedia.org/wiki/JSON >`_ file and then stored in the **pysteps.rcparams **, a dictionary-like object
163
167
that can be accessed as attributes or as items.
164
168
165
169
.. toctree ::
@@ -181,7 +185,3 @@ Launch Python and import pysteps::
181
185
182
186
python
183
187
>>> import pysteps
184
-
185
- **Important **: The Python interpreter must be launched outside of the pysteps directory.
186
- Otherwise, it confuses the name of the directory with the package name.
187
- See `Issue 40 <https://github.com/pySTEPS/pysteps/issues/40 >`_.
0 commit comments