Skip to content

Commit 686d7f7

Browse files
committed
Docs update to 0.7.0
1 parent 7b7b162 commit 686d7f7

File tree

8 files changed

+1495
-861
lines changed

8 files changed

+1495
-861
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ install -e ../jupyter_Pandas_GUI` in the _Production_
135135
instructions.
136136

137137
#### Change Log
138-
* 0.7.0rc8
138+
* 0.7.0
139139
* GUIs now also work in Jupyter Lab and Google Colab, although less
140140
elegently than in classic Jupyter. Only the fit range selection tab
141141
does not yet work in Google Colab.

docs/intro.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@
1414
This package provides GUI tools to help the user construct Pandas and Python
1515
expressions
1616
to create things such as new calculated columns, plots or fits. The tools are
17-
meant to run in an interactive Jupyter notebook. **Currently, they only work
18-
in the classic Jupyter notebook and not Jupyter lab.** All tools are based on
19-
Jupyter widgets.
17+
meant to run in an interactive Jupyter notebook in
18+
[classic Jupyter](https://jupyter-notebook.readthedocs.io/en/latest/),
19+
[Jupyter Lab](https://jupyterlab.readthedocs.io/en/stable/)
20+
and [Google Colab](https://colab.research.google.com/). All tools are based on ipywidgets widgets.
2021

2122
These tools are meant to help the user learn how to construct the commands.
2223
They are intended for new or occasional users of Pandas. However,
@@ -27,11 +28,14 @@ the ability to choose python objects from menus can reduce errors.
2728

2829
The user can pass the GUI tools a list of Pandas
2930
DataFrames to work with. If nothing is passed, the GUI will look for
30-
Pandas DataFrames in the interactive session. The whole GUI and the Jupyter
31-
cell that created it are deleted when done. This leaves only the code that was
32-
generated by the GUI and the results of running the generated code.
33-
34-
The generated code contains sparse comments meant to help new users
31+
Pandas DataFrames in the interactive session. In classic Jupyter the whole GUI
32+
and the Jupyter cell that created it are deleted when done. This leaves
33+
only the code that was generated by the GUI and the results of running the
34+
generated code. In Colab and Lab the code is generated in an editable text
35+
box. In Colab it can be run by clicking a button. In Lab it is best to copy
36+
the code into a new cell before running it.
37+
38+
The generated code contains comments meant to help new users
3539
understand the code.
3640

3741
*Currently defined GUIs:*
@@ -48,13 +52,14 @@ understand the code.
4852

4953
* `fit_pandas_GUI()`: A GUI with six steps to lead the user through fitting
5054
Pandas data to a line, polynomial, exponential, Gaussian or sine function.
55+
**Selecting regions of the data set to fit does NOT currently
56+
work in Colab**.
5157

5258
<img src = "https://jupyterphysscilab.github.io/jupyter_Pandas_GUI/DataSets/GUI_fitexp_1.png" style="width:90%;"/>
5359

5460
#### Wishlist:
5561

5662
* GUIs for plots beyond scatter/line plots.
57-
* Make the GUIs work in Jupyter Lab.
5863

5964
#### Usage:
6065
If the `jupyter_Pandas_GUI` is installed in your Jupyter/Python environment
@@ -95,15 +100,16 @@ available in your command shell. More discussion:
95100
1. Navigate to the directory where this package will be installed.
96101
1. Start a shell in the environment `$ pipenv shell`.
97102
1. Install using pip.
98-
1. `$ pip install jupyter-Pandas-GUI`. This will install
103+
1. `pip install jupyter-Pandas-GUI`. This will install
99104
Jupyter into the same virtual
100105
environment if you do not already have it on your machine. If Jupyter is already
101106
installed the virtual environment will use the existing installation. This takes
102107
a long time on a Raspberry Pi. It will not run on a 3B+ without at least 1 GB of
103108
swap. See: [Build Jupyter on a Pi
104109
](https://www.uwosh.edu/facstaff/gutow/computer-and-programming-how-tos/installing-jupyter-on-raspberrian).
105110
2. Still within the environment shell test this by starting jupyter
106-
`$ jupyter notebook`. Jupyter should launch in your browser.
111+
`jupyter notebook` or `Jupyter lab`. The version of Jupyter requested should
112+
launch in your browser.
107113
1. Open a new notebook using the default (Python 3) kernel.
108114
1. In the first cell import the pandas_GUI module:
109115
`from pandas_GUI import *`
@@ -129,6 +135,14 @@ install -e ../jupyter_Pandas_GUI` in the _Production_
129135
instructions.
130136

131137
#### Change Log
138+
* 0.7.0
139+
* GUIs now also work in Jupyter Lab and Google Colab, although less
140+
elegently than in classic Jupyter. Only the fit range selection tab
141+
does not yet work in Google Colab.
142+
* Some minor bug fixes and clarification of instructions.
143+
* More and better comments in generated code.
144+
* Replacement of notebook cell javascript tools with those from JPSLUtils
145+
is complete.
132146
* 0.6.2.1 Fix for python move of `Iterable` to `collections.abc`
133147
* 0.6.2
134148
* Can now pass dataframes to the GUIs and they will search for additional

docs/pandas_GUI.html

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ <h2>API Documentation</h2>
3939
</ul>
4040

4141

42-
<footer>jupyter_Pandas_GUI v0.6.2.1</footer>
42+
<footer>jupyter_Pandas_GUI v0.7.0</footer>
4343

4444
<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev">
4545
built with <span class="visually-hidden">pdoc</span><img
@@ -107,9 +107,10 @@ <h4 id="introduction">Introduction:</h4>
107107
<p>This package provides GUI tools to help the user construct Pandas and Python
108108
expressions
109109
to create things such as new calculated columns, plots or fits. The tools are
110-
meant to run in an interactive Jupyter notebook. <strong>Currently, they only work
111-
in the classic Jupyter notebook and not Jupyter lab.</strong> All tools are based on
112-
Jupyter widgets.</p>
110+
meant to run in an interactive Jupyter notebook in
111+
<a href="https://jupyter-notebook.readthedocs.io/en/latest/">classic Jupyter</a>,
112+
<a href="https://jupyterlab.readthedocs.io/en/stable/">Jupyter Lab</a>
113+
and <a href="https://colab.research.google.com/">Google Colab</a>. All tools are based on ipywidgets widgets.</p>
113114

114115
<p>These tools are meant to help the user learn how to construct the commands.
115116
They are intended for new or occasional users of Pandas. However,
@@ -120,11 +121,14 @@ <h4 id="current-features">Current Features:</h4>
120121

121122
<p>The user can pass the GUI tools a list of Pandas
122123
DataFrames to work with. If nothing is passed, the GUI will look for
123-
Pandas DataFrames in the interactive session. The whole GUI and the Jupyter
124-
cell that created it are deleted when done. This leaves only the code that was
125-
generated by the GUI and the results of running the generated code.</p>
126-
127-
<p>The generated code contains sparse comments meant to help new users
124+
Pandas DataFrames in the interactive session. In classic Jupyter the whole GUI
125+
and the Jupyter cell that created it are deleted when done. This leaves
126+
only the code that was generated by the GUI and the results of running the
127+
generated code. In Colab and Lab the code is generated in an editable text
128+
box. In Colab it can be run by clicking a button. In Lab it is best to copy
129+
the code into a new cell before running it.</p>
130+
131+
<p>The generated code contains comments meant to help new users
128132
understand the code.</p>
129133

130134
<p><em>Currently defined GUIs:</em></p>
@@ -139,7 +143,9 @@ <h4 id="current-features">Current Features:</h4>
139143

140144
<p><img src = "https://jupyterphysscilab.github.io/jupyter_Pandas_GUI/DataSets/plot_GUI.png" style="width:90%;"/></p></li>
141145
<li><p><code>fit_pandas_GUI()</code>: A GUI with six steps to lead the user through fitting
142-
Pandas data to a line, polynomial, exponential, Gaussian or sine function.</p>
146+
Pandas data to a line, polynomial, exponential, Gaussian or sine function.
147+
<strong>Selecting regions of the data set to fit does NOT currently
148+
work in Colab</strong>.</p>
143149

144150
<p><img src = "https://jupyterphysscilab.github.io/jupyter_Pandas_GUI/DataSets/GUI_fitexp_1.png" style="width:90%;"/></p></li>
145151
</ul>
@@ -148,7 +154,6 @@ <h4 id="wishlist">Wishlist:</h4>
148154

149155
<ul>
150156
<li>GUIs for plots beyond scatter/line plots.</li>
151-
<li>Make the GUIs work in Jupyter Lab.</li>
152157
</ul>
153158

154159
<h4 id="usage">Usage:</h4>
@@ -197,15 +202,16 @@ <h4 id="installation">Installation:</h4>
197202
<li><p>Install using pip.</p>
198203

199204
<ol>
200-
<li><code>$ pip install jupyter-Pandas-GUI</code>. This will install
205+
<li><code>pip install jupyter-Pandas-GUI</code>. This will install
201206
Jupyter into the same virtual
202207
environment if you do not already have it on your machine. If Jupyter is already
203208
installed the virtual environment will use the existing installation. This takes
204209
a long time on a Raspberry Pi. It will not run on a 3B+ without at least 1 GB of
205210
swap. See: <a href="https://www.uwosh.edu/facstaff/gutow/computer-and-programming-how-tos/installing-jupyter-on-raspberrian">Build Jupyter on a Pi
206211
</a>.</li>
207212
<li>Still within the environment shell test this by starting jupyter
208-
<code>$ jupyter notebook</code>. Jupyter should launch in your browser.
213+
<code>jupyter notebook</code> or <code>Jupyter lab</code>. The version of Jupyter requested should
214+
launch in your browser.
209215
<ol>
210216
<li>Open a new notebook using the default (Python 3) kernel.</li>
211217
<li>In the first cell import the pandas_GUI module:
@@ -241,6 +247,17 @@ <h4 id="installation">Installation:</h4>
241247
<h4 id="change-log">Change Log</h4>
242248

243249
<ul>
250+
<li>0.7.0
251+
<ul>
252+
<li>GUIs now also work in Jupyter Lab and Google Colab, although less
253+
elegently than in classic Jupyter. Only the fit range selection tab
254+
does not yet work in Google Colab.</li>
255+
<li>Some minor bug fixes and clarification of instructions.</li>
256+
<li>More and better comments in generated code.</li>
257+
<li>Replacement of notebook cell javascript tools with those from JPSLUtils
258+
is complete.</li>
259+
</ul></li>
260+
<li>0.6.2.1 Fix for python move of <code>Iterable</code> to <code>collections.abc</code></li>
244261
<li>0.6.2
245262
<ul>
246263
<li>Can now pass dataframes to the GUIs and they will search for additional

0 commit comments

Comments
 (0)