Skip to content

Commit 9a74430

Browse files
authored
Update getting_started.md with standardized image paths and labels (#43)
* Update getting_started.md with standardized image paths and labels Changes: - Add (getting_started)= label after line 11 for cross-references - Convert 11 image references from images/getting-started/ to _static/lecture_specific/getting_started/ for consistency - Add :figclass: auto to 10 figures (standard style) - Add :figclass: terminal to starting_nb.png (terminal screenshot) - Add :scale: 50% to debug.png per English source - Namespace all :name: attributes with gs_ prefix to avoid global label collisions (gs_jp_demo, gs_starting_nb, gs_nb, etc.) This aligns the Persian translation with the established conventions from the English source and other QuantEcon lectures. * Add MyST structural elements to getting_started.md - Add raw jupyter directive with QuantEcon header banner - Add index roles for Python, Anaconda, IPython, Jupyter, JupyterLab, QuantEcon - Add target labels: install_anaconda, ipython_notebook, a_test_program, gs_help, gs_qe, gs_install_qe - Add {ref} cross-reference to Docstrings - Translate secondary index terms to Persian (راه‌اندازی, مبانی, راهنما, اشکال‌زدایی, اشتراک‌گذاری) - Keep proper nouns in English for index entries
1 parent 44bf06c commit 9a74430

File tree

1 file changed

+124
-13
lines changed

1 file changed

+124
-13
lines changed

lectures/getting_started.md

Lines changed: 124 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,20 @@ kernelspec:
99
name: python3
1010
---
1111

12+
(getting_started)=
13+
```{raw} jupyter
14+
<div id="qe-notebook-header" align="right" style="text-align:right;">
15+
<a href="https://quantecon.org/" title="quantecon.org">
16+
<img style="width:250px;display:inline;" width="250px" src="https://assets.quantecon.org/img/qe-menubar-logo.svg" alt="QuantEcon">
17+
</a>
18+
</div>
19+
```
20+
1221
# بیاین شروع کنیم
1322

23+
```{index} single: Python
24+
```
25+
1426
## مقدمه
1527

1628
در این بخش شما خواهید آموخت که چگونه:
@@ -50,7 +62,12 @@ kernelspec:
5062

5163
**تمام مطالبی که در ادامه خواهید آموخت بر این فرض استوار است که شما این توصیه ها را پذیرفته اید!**
5264

65+
(install_anaconda)=
5366
### نصب آناکوندا
67+
68+
```{index} single: Python; Anaconda
69+
```
70+
5471
برای نصب آناکوندا فایل باینری را از سایت اصلی آناکوندا [دانلود](https://www.anaconda.com/download/) کرده و دستورالعمل ها را دنبال کنید.
5572

5673
نکات:
@@ -72,7 +89,15 @@ kernelspec:
7289

7390
برای اطلاعات بیشتر درباره کوندا، در ترمینال عبارت " conda help " را تایپ کنید.
7491

75-
## ژوپیتر نوت بوک
92+
(ipython_notebook)=
93+
## Jupyter Notebooks
94+
95+
```{index}
96+
single: Python; IPython
97+
single: IPython
98+
single: Jupyter
99+
```
100+
76101
[ژوپیتر](http://jupyter.org/) نوت بوک ها یکی از چندین راه های قابل دسترس برای ارتباط برقرار کردن با پایتون هستند.
77102
ژوپیتر نوت بوک ها از یک رابط مبتنی بر مرورگر برای دسترسی به پایتون استفاده می کنند که دارای ویژگی های زیر است:
78103

@@ -86,7 +111,12 @@ kernelspec:
86111
به دلیل این قابلیت ها، امروزه ژوپیتر یکی از ابزارهای مهم در اکوسیستم محاسبات علمی محسوب می شود.
87112
در [اینجا](http://matplotlib.org/examples/pylab_examples/hexbin_demo.html) تصویری از اجرای کد در یک ژوپیتر نوت بوک آورده شده است.
88113

89-
![نمونه اجرای کد](images/getting-started/jp_demo.png)
114+
```{figure} _static/lecture_specific/getting_started/jp_demo.png
115+
:name: gs_jp_demo
116+
:figclass: auto
117+
118+
نمونه اجرای کد
119+
```
90120

91121
درحالیکه ژوپیتر تنها روش برنامه نویسی در پایتون نیست، اما بهترین گزینه برای موقعیت هایی است که:
92122

@@ -102,6 +132,9 @@ kernelspec:
102132

103133
### راه اندازی ژوپیتر نوت بوک
104134

135+
```{index} single: Jupyter Notebook; راه‌اندازی
136+
```
137+
105138
بعد از نصب آناکوندا، شما می توانید ژوپیتر نوت بوک را اجرا کنید.
106139

107140
برای اینکار می توانید:
@@ -113,7 +146,12 @@ kernelspec:
113146

114147
اگر روش دوم را انتخاب کنید، با چیزی مشابه تصویر زیر رو به رو خواهید شد.
115148

116-
![ترمینال](images/getting-started/starting_nb.png)
149+
```{figure} _static/lecture_specific/getting_started/starting_nb.png
150+
:name: gs_starting_nb
151+
:figclass: terminal
152+
153+
ترمینال
154+
```
117155

118156
خروجی نشان می دهد که نوت بوک در `/http://localhost:8888` در حال اجرا است.
119157

@@ -126,7 +164,12 @@ kernelspec:
126164

127165
اگر همه چیز به درستی پیش رفته باشد، مرورگر پیش فرض شما باید به طور خودکار یک صفحه ی وب مشابه تصویر زیر را باز کرده باشد.
128166

129-
![ژوپیتر](images/getting-started/nb.png)
167+
```{figure} _static/lecture_specific/getting_started/nb.png
168+
:name: gs_nb
169+
:figclass: auto
170+
171+
ژوپیتر
172+
```
130173

131174

132175
آنچه در اینجا می بینید *داشبورد* ژوپیتر نام دارد.
@@ -136,11 +179,21 @@ kernelspec:
136179
در صورتیکه همه چیز به درستی کار کرده باشد، اکنون می توانید روی "New" در گوشه ی بالا سمت راست کلیک کنید و `Python 3` یا چیزی مشابه آن را انتخاب کنید.
137180

138181
در زیر تصویری که در سیستم ما نشان می دهد را میتوانید ببینید:
139-
![ژوپیتر2](images/getting-started/nb2.png)
182+
183+
```{figure} _static/lecture_specific/getting_started/nb2.png
184+
:name: gs_nb2
185+
:figclass: auto
186+
187+
ژوپیتر
188+
```
140189

141190
نوت بوک یک سلول کد فعال را نشان می دهد که می توانید دستورات پایتون را در آن وارد کنید.
142191

143192
### اصول اولیه نوت بوک
193+
194+
```{index} single: Jupyter Notebook; مبانی
195+
```
196+
144197
بیاید با نحوه ی ویرایش کد و اجرای برنامه های ساده شروع کنیم.
145198

146199
#### اجرای سلول ها
@@ -150,7 +203,12 @@ kernelspec:
150203

151204
وقتی آماده ی اجرای کدی که در سلول نوشتید هستید، به جای آنکه به طور معمول از "Enter" استفاده کنید، کلیدهای "Shift + Enter" را بزنید.
152205

153-
![ژوپیتر3](images/getting-started/nb3.png)
206+
```{figure} _static/lecture_specific/getting_started/nb3.png
207+
:name: gs_nb3
208+
:figclass: auto
209+
210+
ژوپیتر
211+
```
154212

155213
```{note}
156214
همچنین با کمی جستجو می توانید گزینه های منو و دکمه هایی را برای اجرای کد درون سلول پیدا کنید.
@@ -190,6 +248,7 @@ kernelspec:
190248

191249
در یک سلول، عبارت `alpha/` را تایپ کنید و سپس کلید Tab را از صفحه کیبورد خود فشار دهید.
192250

251+
(a_test_program)=
193252
#### یک برنامه ی آزمایشی
194253

195254
بیایید یک برنامه آزمایشی اجرا کنیم.
@@ -245,23 +304,37 @@ plt.show()
245304

246305
برای نمونه، کافی است تایپ کنیم `np.random.r` و سپس کلید Tab را فشار دهیم.
247306

248-
![numpy](images/getting-started/nb6.png)
307+
```{figure} _static/lecture_specific/getting_started/nb6.png
308+
:name: gs_nb6
309+
:figclass: auto
310+
311+
numpy
312+
```
249313

250314
ژوپیتر نوت بوک چندین گزینه ی تکمیل کننده ی خودکار را برای انتخاب در اختیارتان قرار می دهد.
251315

252316
به همین ترتیب، کلید Tab هم یادآوری می کند که چه قابلیت هایی در دسترس شما قرار دارد و هم باعث صرفه جویی در تایپ می شود.
253317

318+
(gs_help)=
254319
#### راهنمای آنلاین
255320

321+
```{index} single: Jupyter Notebook; راهنما
322+
```
323+
256324
برای مشاهده ی راهنمای نحو `np.random.randn` کافی است دستور `?np.random.randn` را اجرا کنید.
257325

258326
مستندات مربوط به این نحو در پنجره ای به طور جداگانه همانند تصویر زیر نمایش داده می شود.
259327

260-
![online help](images/getting-started/nb6a.png)
328+
```{figure} _static/lecture_specific/getting_started/nb6a.png
329+
:name: gs_nb6a
330+
:figclass: auto
331+
332+
online help
333+
```
261334

262335
با کلیک بر روی ضربدر در قسمت بالایی سمت راست در نیم پنجره ی ایجاد شده برای راهنمای دستور، راهنمای آنلاین بسته می شود.
263336

264-
در ادامه، بیشتر درباره ی نحوه ی ایجاد مستندات مشابه بیشتر یادخواهیم گرفت!
337+
در ادامه، بیشتر درباره ی نحوه ی ایجاد مستندات مشابه {ref}`یاد خواهیم گرفت <Docstrings>`!
265338

266339
#### سایر محتواها
267340

@@ -273,21 +346,40 @@ plt.show()
273346

274347
(همچنین می توانید با استفاده از ماوس، گزینه " Markdown " را از منوی کشویی "Code" که درست زیر نوار منو قرار دارد، انتخاب کنید.)
275348

276-
![markdown](images/getting-started/nb7.png)
349+
```{figure} _static/lecture_specific/getting_started/nb7.png
350+
:name: gs_nb7
351+
:figclass: auto
352+
353+
markdown
354+
```
277355

278356
حال ما کلیدهای `Shift + Enter` را میزنیم تا نتیجه ای مطابق تصویر زیر ایجاد کنیم:
279357

280-
![resultmd](images/getting-started/nb8.png)
358+
```{figure} _static/lecture_specific/getting_started/nb8.png
359+
:name: gs_nb8
360+
:figclass: auto
361+
362+
resultmd
363+
```
281364

282365
### اشکال زدایی کد
283366

367+
```{index} single: Jupyter Notebook; اشکال‌زدایی
368+
```
369+
284370
به فرآیند شناسایی و حذف خطاها از یک برنامه، اشکال زدایی یا Debugging می گویند.
285371

286372
ازآنجایی که شما زمان زیادی را صرف اشکال زدایی کد خواهید کرد، بنابراین [یادگرفتن نحوه ی انجام درست](https://www.freecodecamp.org/news/what-is-debugging-how-to-debug-code/) آن ضروری است.
287373

288374
اگر از نسخه ی جدیدتری از ژوپیتر نوت بوک استفاده می کنید، باید نماد یک حشره (bug) را در انتهای سمت راست نوار ابزار خود داشته باشید.
289375

290-
![dedugicon](images/getting-started/debug.png)
376+
```{figure} _static/lecture_specific/getting_started/debug.png
377+
:name: gs_debug
378+
:scale: 50%
379+
:figclass: auto
380+
381+
debug icon
382+
```
291383

292384
با کلیک بر روی این آیکون، اشکال زدایی ژوپیتر فعال می شود.
293385

@@ -300,12 +392,23 @@ plt.show()
300392

301393
سپس می توانید خط به خط کد را با استفاده از دکمه های "Next" که در نوار ابزار CALLSTACK در پنجره ی سمت راست قرار دارد، بررسی کنید.
302394

303-
![degug2](images/getting-started/debugger_breakpoint.png)
395+
```{figure} _static/lecture_specific/getting_started/debugger_breakpoint.png
396+
:name: gs_debugger_breakpoint
397+
:figclass: auto
398+
399+
debugger breakpoint
400+
```
304401

305402
می توانید قابلیت های بیشتری از اشکال زدایی در ژوپیتر را در [اینجا](https://jupyterlab.readthedocs.io/en/latest/user/debugger.html) پیدا کنید.
306403

307404
### اشتراک گذاری نوت بوک ها
308405

406+
```{index} single: Jupyter Notebook; اشتراک‌گذاری
407+
```
408+
409+
```{index} single: Jupyter Notebook; nbviewer
410+
```
411+
309412
فایل های نوت بوک صرفا فایل های متنی با ساختار [JSON](https://en.wikipedia.org/wiki/JSON) هستند که معمولا پسوند `.ipynb` دارند.
310413

311414
شما می توانید آن ها را به همان شیوه که سایر فایل ها را به اشتراک می گذارید، ارسال کنید یا اینکه از سرویس های وب مانند [nbviewer](http://nbviewer.jupyter.org/) استفاده کنید.
@@ -334,10 +437,15 @@ plt.show()
334437

335438
## نصب کتابخانه ها
336439

440+
(gs_qe)=
441+
```{index} single: QuantEcon
442+
```
443+
337444
بیشتر کتابخانه های موردنیاز ما در این دوره در آناکوندا وجود دارند. اما سایر کتابخانه ها را می توان با `conda` یا `pip` نصب کرد.
338445

339446
یکی از کتابخانه هایی که از آن استفاده خواهیم کرد، [QuantEcon.py](http://quantecon.org/quantecon-py) است.
340447

448+
(gs_install_qe)=
341449
شما می توانید با اجرای ژوپیتر و تایپ دستور زیر درون یک سلول [QuantEcon.py](http://quantecon.org/quantecon-py) را نصب کنید.
342450

343451
```{code-block} ipython3
@@ -401,6 +509,9 @@ print("foobar")
401509

402510
#### گزینه اول: JupyterLab
403511

512+
```{index} single: JupyterLab
513+
```
514+
404515
محیط [JupyterLab](https://github.com/jupyterlab/jupyterlab) یک محیط توسعه ی یکپارچه (IDE) است که بر پایه ی نوت بوک ها ژوپیتر ساخته شده است. با استفاده از JupyterLab می توانید فایل هایی با پسوند `*.py` را همانند ژوپیتر نوت بوک ها را ویرایش و اجرا کنید.
405516

406517
برای اجرای JupyterLab می توانید آن را در فهرست برنامه ها جستجو کنید یا در ترمینال دستور `jupyter-lab` را وارد نمایید.

0 commit comments

Comments
 (0)