@@ -74,47 +74,3 @@ Then, in the ``docs`` directory, run::
7474
7575Open the produced file ``_build/html/index.html `` in your navigator to browse
7676your local version of the documentation.
77-
78- Installation in a virtual environment
79- -------------------------------------
80-
81- A ``Makefile `` in the git repository allows you to install the development
82- version of StagPy in a virtual environment with all the necessary dependencies.
83- Simply run ``make `` to do so.
84-
85- The version installed in the virtual environment points directly towards the
86- source files. It means that you don't need to run ``make `` again for your
87- changes to the source files to be taken into account.
88-
89- To activate the virtual environment, source the relevant script::
90-
91- % source stagpy_git/bin/activate
92-
93- Once this is done, launching the ``stagpy `` command and importing StagPy in a
94- Python script (``import stagpy ``) will use the development version of StagPy.
95- To check that everything works fine, go to any subdirectory of the ``Examples ``
96- directory of the repository and run::
97-
98- % stagpy field
99-
100- This should create a PDF file showing a plot of the temperature field with
101- streamlines.
102-
103- Launch the ``deactivate `` command to get out of the virtual environment.
104-
105- Use as a Jupyter notebook kernel
106- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
107-
108- If you want to access the virtual environment - and therefore the development
109- version of StagPy - in a Jupyter notebook, run
110- ::
111-
112- % make notebook-kernel
113-
114- This will create a new Jupyter kernel named ``stagpy-git `` you can use to
115- access the virtual environment in a notebook.
116-
117- To remove that kernel, run
118- ::
119-
120- % jupyter kernelspec uninstall stagpy-git
0 commit comments