DOC Update project subtitle to be more general#1246
Conversation
| ## What is Pyodide? | ||
|
|
||
| **Pyodide** brings the Python 3.8 runtime to the browser via WebAssembly, along with the Python scientific stack including NumPy, Pandas, Matplotlib, parts of SciPy, and NetworkX. The [`packages` directory](https://github.com/iodide-project/pyodide/tree/master/packages) lists over 35 packages which are currently available. | ||
| **Pyodide** brings the Python 3.8 runtime to the browser via WebAssembly, along with the Python scientific stack including NumPy, Pandas, Matplotlib, SciPy, and scikit-learn. The [`packages` directory](https://github.com/iodide-project/pyodide/tree/master/packages) lists over 75 packages which are currently available. In addition it's possible to install pure Python wheels from PyPi. |
There was a problem hiding this comment.
scikit-learn probably has a larger user base than networkx, and my personal goal is to make scikit-learn work well in pyodide :) It was mostly blocked by scipy previously, which should be resolved now.
docs/index.rst
Outdated
| Pyodide may be used in several ways: directly from JavaScript, or to execute | ||
| Python scripts asynchronously in a web worker. Although still experimental, | ||
| additional packages may be installed from PyPI to be used with Pyodide. | ||
| Python scripts asynchronously in a web worker. Additional packages may be |
There was a problem hiding this comment.
micropip is as experimental as everything else in pyodiode, I'm not sure we need to highlight it specifically.
There was a problem hiding this comment.
This version sounds much better. Maybe we could also name it
Additional pure Python packages may be installed from PyPI to be used with Pyodide.
|
Like the commenter in #593, I mostly have no interest in most of the Python scientific stack. (I care about mathematical computing, but I don't do anything with floating point arithmetic, instead most of what I do is arithmetic in finite fields.) From a pedagogical perspective, the high degree of compatibility with native CPython is desirable because if you teach students in Pyodide, any difference between the behavior of Pyodide and the behavior of CPython is likely to end up confusing them. The fact that our primary goal is maximizing the compatibility (because you want a large number of packages to work) ends up making Pyodide a relatively good tool for teaching. Anyways "Python and the scientific stack, compiled to WebAssembly" sounds good to me. |
README.md
Outdated
| [](https://pyodide.readthedocs.io/?badge=latest) | ||
|
|
||
| The Python scientific stack, compiled to WebAssembly. | ||
| Python and the scientific stack, compiled to WebAssembly. |
There was a problem hiding this comment.
What about
Python, including the scientific stack, compiled to WebAssembly.
? Or
Python in WebAssembly - And no compromises!
okay latter one is a little joke maybe. For me, your original draft is also just fine.
Including might be a bit too long in the title, also I'm not sure what's the correct name for this grammatical construction but the two commas make it a bit harder to read IMO. How about,
It might be a bit better than "and" |
That is nice. What about this comment? |
Thanks done! |
| Pyodide may be used in several ways: directly from JavaScript, or to execute | ||
| Python scripts asynchronously in a web worker. Additional packages may be | ||
| installed from PyPI to be used with Pyodide. | ||
| Python scripts asynchronously in a web worker. Additional Pure python packages |
There was a problem hiding this comment.
probably should be "pure" with a lower case p and "Python" with an upper case P.
There was a problem hiding this comment.
Yes, probably. I'll have to do another PR to improve the documentation now...
3 participants
Closes #553
Changes the project subtitle to be more general.
From
to
Or maybe
(not sure if we need a comma after Python).
The vast majority of users don't use the scientific stack and just use Python with Pyodide (e.g. for teaching). Also a number of included packages are not scientific packages, so maybe we should go with a more general
as suggested in #553
WDYT?