@@ -13,10 +13,10 @@ objectives:
1313 - " Demonstrate how to provide sufficient information for troubleshooting with the Python user
1414 community."
1515keypoints :
16- - " Python is an open source and platform independent programming language"
17- - " SciPy ecosystem for Python provides the tools necessary for scientific computing"
18- - " Jupyter Notebook and the Spyder IDE are great tools to code in and interact with Python with
19- its large community it is easy to find help in the internet"
16+ - " Python is an open source and platform independent programming language. "
17+ - " SciPy ecosystem for Python provides the tools necessary for scientific computing. "
18+ - " Jupyter Notebook and the Spyder IDE are great tools to code in and interact with Python. With
19+ the large Python community it is easy to find help in the internet. "
2020---
2121
2222<br />
@@ -39,7 +39,7 @@ Its main advantages are:
3939
4040- ** Easy to learn:**
4141Python is easier to learn than other programming languages. This is important because lower barriers
42- mean it is easier for new members of the community get up to speed.
42+ mean it is easier for new members of the community to get up to speed.
4343
4444- ** Reproducibility:**
4545Reproducibility is the ability to obtain the same results using the same dataset(s) and analysis.
@@ -100,7 +100,7 @@ your scripts, data, and documents.
100100
101101- ** ` data/ ` ** : Use this folder to store your raw data. For the sake of transparency and provenance,
102102you should always keep a copy of your ** raw data** . If you need to cleanup data, do it
103- programmatically (_ i.e._ with scripts) and make sure to separate cleaned up data from the raw one .
103+ programmatically (_ i.e._ with scripts) and make sure to separate cleaned up data from the raw data .
104104For example, you can store raw data in files ` ./data/raw/ ` and clean data in ` ./data/clean/ ` .
105105
106106- ** ` documents/ ` ** : Use this folder to store outlines, drafts, and other text.
@@ -110,7 +110,7 @@ plotting that you use in this particular project.
110110
111111You may need to create additional directories depending on your project needs, but these should form
112112the backbone of your project's directory. For this workshop, we will need a ` data/ ` folder to store
113- our raw data, and we will create later a ` data_output/ ` folder when we learn how to export data as
113+ our raw data, and we will later create a ` data_output/ ` folder when we learn how to export data as
114114CSV files.
115115
116116
@@ -146,7 +146,7 @@ shown. You can execute commands directly in the console by pressing <kbd>Return
146146will be "lost" when you close the session. Spyder uses the [ IPython] ( http://ipython.org ) console by
147147default.
148148
149- Because we want our code and workflow to be reproducible, it is better to type the commands in
149+ Since we want our code and workflow to be reproducible, it is better to type the commands in
150150the script editor, and save them as a script. This way, there is a complete record of what we did,
151151and anyone (including our future selves!) can easily reproduce the results on their computer.
152152
@@ -195,8 +195,8 @@ Finally, a generic Google or internet search "Python task" will often either sen
195195appropriate module documentation or a helpful forum where someone else has already asked your
196196question.
197197
198- I am stuck... I get an error message that I don’t understand
199- Start by googling the error message. However, this doesn’t always work very well because often,
198+ I am stuck... I get an error message that I don’t understand.
199+ Start by googling the error message. However, this doesn’t always work very well, because often,
200200package developers rely on the error catching provided by python. You end up with general error
201201messages that might not be very helpful to diagnose a problem (e.g. "subscript out of bounds"). If
202202the message is very generic, you might also include the name of the function or package you’re using
@@ -219,7 +219,7 @@ trying to help you. Be as precise as possible when describing your problem.
219219If possible, try to reduce what doesn’t work to a simple reproducible example. If you can reproduce
220220the problem using a very small data frame instead of your 50,000 rows and 10,000 columns one,
221221provide the small one with the description of your problem. When appropriate, try to generalize what
222- you are doing so even people who are not in your field can understand the question. For instance
222+ you are doing so even people who are not in your field can understand the question. For instance,
223223instead of using a subset of your real dataset, create a small (3 columns, 5 rows) generic one.
224224
225225### Where to ask for help?
0 commit comments