You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
:alt:Modin
6
6
7
7
=================
8
-
modin-spreadsheet
8
+
Modin-spreadsheet
9
9
=================
10
10
Modin-spreadsheet is the underlying package for the `Modin <https://modin.readthedocs.io>`_ Spreadsheet API. It renders
11
11
DataFrames within a Jupyter notebook as a spreadsheet and makes it easy to explore with intuitive scrolling, sorting,
@@ -36,7 +36,7 @@ Full documentation for Modin-spreadsheet is still in progress. Most features are
36
36
37
37
Installation
38
38
------------
39
-
Modin-spreadsheet is intended be used through the `Modin Spreadsheet API <https://modin.readthedocs.io>`_ (Docs in progress...). Please install Modin and modin-spreadsheet by running the following: ::
39
+
Modin-spreadsheet is intended be used through the `Modin Spreadsheet API <https://modin.readthedocs.io>`_ (Docs in progress...). Please install Modin and Modin-spreadsheet by running the following: ::
40
40
41
41
pip install modin
42
42
pip install modin[spreadsheet]
@@ -99,8 +99,8 @@ The Events API provides ``on`` and ``off`` methods which can be used to attach/d
99
99
on both the ``modin_spreadsheet`` module (see `qgrid.on <https://qgrid.readthedocs.io/en/latest/#qgrid.on>`_), and on
100
100
individual SpreadsheetWidget instances (see `qgrid.QgridWidget.on <https://qgrid.readthedocs.io/en/latest/#qgrid.QgridWidget.on>`_).
101
101
102
-
Having the ability to attach event handlers allows us to do some interesting things in terms of using modin-spreadsheet
103
-
in conjunction with other widgets/visualizations. One example is using modin-spreadsheet to filter a DataFrame that's
102
+
Having the ability to attach event handlers allows us to do some interesting things in terms of using Modin-spreadsheet
103
+
in conjunction with other widgets/visualizations. One example is using Modin-spreadsheet to filter a DataFrame that's
104
104
also being displayed by another visualization.
105
105
106
106
Here's how you would use the ``on`` method to print the DataFrame every time there's a change made::
@@ -114,7 +114,7 @@ Here's how you would use the ``on`` method to print the DataFrame every time the
114
114
115
115
Here are some examples of how the Events API can be applied.
116
116
117
-
This shows how you can use modin-spreadsheet to filter the data that's being shown by a matplotlib scatter plot:
117
+
This shows how you can use Modin-spreadsheet to filter the data that's being shown by a matplotlib scatter plot:
118
118
119
119
.. figure:: docs/images/linked_to_scatter.gif
120
120
:align:left
@@ -136,8 +136,8 @@ the functionality is the same on Jupyter Notebook.
136
136
Running from source & testing your changes
137
137
------------------------------------------
138
138
139
-
If you'd like to contribute to modin-spreadsheet, or just want to be able to modify the source code for your own purposes, you'll
140
-
want to clone this repository and run modin-spreadsheet from your local copy of the repository. The following steps explain how
139
+
If you'd like to contribute to Modin-spreadsheet, or just want to be able to modify the source code for your own purposes, you'll
140
+
want to clone this repository and run Modin-spreadsheet from your local copy of the repository. The following steps explain how
141
141
to do this.
142
142
143
143
#. Clone the repository from GitHub and ``cd`` into the top-level directory::
@@ -150,11 +150,11 @@ to do this.
150
150
151
151
pip install -e .
152
152
153
-
#. Install the node packages that modin-spreadsheet depends on and build modin-spreadsheet's javascript using webpack::
153
+
#. Install the node packages that Modin-spreadsheet depends on and build Modin-spreadsheet's javascript using webpack::
154
154
155
155
cd js && npm install .
156
156
157
-
#. Install and enable modin-spreadsheet's javascript in your local jupyter notebook environment::
157
+
#. Install and enable Modin-spreadsheet's javascript in your local jupyter notebook environment::
0 commit comments