asimpy 0.4.0__tar.gz → 0.4.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (150) hide show
  1. asimpy-0.4.1/.readthedocs.yaml +15 -0
  2. asimpy-0.4.1/CONTRIBUTING.md +33 -0
  3. {asimpy-0.4.0 → asimpy-0.4.1}/PKG-INFO +2 -2
  4. {asimpy-0.4.0 → asimpy-0.4.1}/docs/404.html +3 -3
  5. {asimpy-0.4.0/docs/CODE_OF_CONDUCT → asimpy-0.4.1/docs/conduct}/index.html +4 -4
  6. {asimpy-0.4.0/docs/CONTRIBUTING → asimpy-0.4.1/docs/contributing}/index.html +154 -11
  7. {asimpy-0.4.0 → asimpy-0.4.1}/docs/examples/index.html +4 -4
  8. {asimpy-0.4.0 → asimpy-0.4.1}/docs/index.html +4 -4
  9. {asimpy-0.4.0/docs/LICENSE → asimpy-0.4.1/docs/license}/index.html +3 -3
  10. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/allof/index.html +3 -3
  11. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/barrier/index.html +3 -3
  12. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/environment/index.html +3 -3
  13. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/event/index.html +3 -3
  14. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/firstof/index.html +3 -3
  15. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/interrupt/index.html +3 -3
  16. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/process/index.html +3 -3
  17. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/resource/index.html +3 -3
  18. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/simqueue/index.html +3 -3
  19. {asimpy-0.4.0 → asimpy-0.4.1}/docs/reference/timeout/index.html +3 -3
  20. asimpy-0.4.1/docs/requirements.txt +6 -0
  21. {asimpy-0.4.0 → asimpy-0.4.1}/docs/sitemap.xml.gz +0 -0
  22. {asimpy-0.4.0 → asimpy-0.4.1}/docs/tutorial/01_minimal/index.html +3 -3
  23. {asimpy-0.4.0 → asimpy-0.4.1}/docs/tutorial/02_queue/index.html +3 -35
  24. {asimpy-0.4.0 → asimpy-0.4.1}/docs/tutorial/03_interrupt/index.html +3 -3
  25. {asimpy-0.4.0 → asimpy-0.4.1}/docs/tutorial/04_combine/index.html +27 -5
  26. asimpy-0.4.1/docs-requirements.txt +6 -0
  27. asimpy-0.4.1/pages/.pages +7 -0
  28. {asimpy-0.4.0 → asimpy-0.4.1}/pages/tutorial/02_queue.md +0 -12
  29. {asimpy-0.4.0 → asimpy-0.4.1}/pages/tutorial/04_combine.md +3 -2
  30. {asimpy-0.4.0 → asimpy-0.4.1}/pyproject.toml +7 -3
  31. {asimpy-0.4.0 → asimpy-0.4.1}/uv.lock +104 -48
  32. asimpy-0.4.0/CONTRIBUTING.md +0 -17
  33. asimpy-0.4.0/pages/.pages +0 -7
  34. {asimpy-0.4.0 → asimpy-0.4.1}/.gitignore +0 -0
  35. {asimpy-0.4.0 → asimpy-0.4.1}/CODE_OF_CONDUCT.md +0 -0
  36. {asimpy-0.4.0 → asimpy-0.4.1}/LICENSE.md +0 -0
  37. {asimpy-0.4.0 → asimpy-0.4.1}/README.md +0 -0
  38. {asimpy-0.4.0 → asimpy-0.4.1}/docs/.nojekyll +0 -0
  39. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/_mkdocstrings.css +0 -0
  40. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/images/favicon.png +0 -0
  41. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/bundle.79ae519e.min.js +0 -0
  42. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/bundle.79ae519e.min.js.map +0 -0
  43. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.ar.min.js +0 -0
  44. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.da.min.js +0 -0
  45. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.de.min.js +0 -0
  46. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.du.min.js +0 -0
  47. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.el.min.js +0 -0
  48. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.es.min.js +0 -0
  49. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.fi.min.js +0 -0
  50. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.fr.min.js +0 -0
  51. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.he.min.js +0 -0
  52. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.hi.min.js +0 -0
  53. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.hu.min.js +0 -0
  54. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.hy.min.js +0 -0
  55. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.it.min.js +0 -0
  56. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.ja.min.js +0 -0
  57. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.jp.min.js +0 -0
  58. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.kn.min.js +0 -0
  59. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.ko.min.js +0 -0
  60. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.multi.min.js +0 -0
  61. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.nl.min.js +0 -0
  62. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.no.min.js +0 -0
  63. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.pt.min.js +0 -0
  64. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.ro.min.js +0 -0
  65. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.ru.min.js +0 -0
  66. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.sa.min.js +0 -0
  67. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +0 -0
  68. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.sv.min.js +0 -0
  69. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.ta.min.js +0 -0
  70. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.te.min.js +0 -0
  71. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.th.min.js +0 -0
  72. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.tr.min.js +0 -0
  73. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.vi.min.js +0 -0
  74. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/min/lunr.zh.min.js +0 -0
  75. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/tinyseg.js +0 -0
  76. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/lunr/wordcut.js +0 -0
  77. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/workers/search.2c215733.min.js +0 -0
  78. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/javascripts/workers/search.2c215733.min.js.map +0 -0
  79. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/stylesheets/main.484c7ddc.min.css +0 -0
  80. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/stylesheets/main.484c7ddc.min.css.map +0 -0
  81. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/stylesheets/palette.ab4e12ef.min.css +0 -0
  82. {asimpy-0.4.0 → asimpy-0.4.1}/docs/assets/stylesheets/palette.ab4e12ef.min.css.map +0 -0
  83. {asimpy-0.4.0 → asimpy-0.4.1}/docs/objects.inv +0 -0
  84. {asimpy-0.4.0 → asimpy-0.4.1}/docs/sitemap.xml +0 -0
  85. {asimpy-0.4.0 → asimpy-0.4.1}/examples/allof.py +0 -0
  86. {asimpy-0.4.0 → asimpy-0.4.1}/examples/barrier.py +0 -0
  87. {asimpy-0.4.0 → asimpy-0.4.1}/examples/firstof_queue.py +0 -0
  88. {asimpy-0.4.0 → asimpy-0.4.1}/examples/firstof_timeout.py +0 -0
  89. {asimpy-0.4.0 → asimpy-0.4.1}/examples/interrupt.py +0 -0
  90. {asimpy-0.4.0 → asimpy-0.4.1}/examples/priqueue.py +0 -0
  91. {asimpy-0.4.0 → asimpy-0.4.1}/examples/queue.py +0 -0
  92. {asimpy-0.4.0 → asimpy-0.4.1}/examples/resource.py +0 -0
  93. {asimpy-0.4.0 → asimpy-0.4.1}/examples/timeout.py +0 -0
  94. {asimpy-0.4.0 → asimpy-0.4.1}/mkdocs.yml +0 -0
  95. {asimpy-0.4.0 → asimpy-0.4.1}/output/allof.txt +0 -0
  96. {asimpy-0.4.0 → asimpy-0.4.1}/output/barrier.txt +0 -0
  97. {asimpy-0.4.0 → asimpy-0.4.1}/output/firstof_queue.txt +0 -0
  98. {asimpy-0.4.0 → asimpy-0.4.1}/output/firstof_timeout.txt +0 -0
  99. {asimpy-0.4.0 → asimpy-0.4.1}/output/interrupt.txt +0 -0
  100. {asimpy-0.4.0 → asimpy-0.4.1}/output/priqueue.txt +0 -0
  101. {asimpy-0.4.0 → asimpy-0.4.1}/output/queue.txt +0 -0
  102. {asimpy-0.4.0 → asimpy-0.4.1}/output/resource.txt +0 -0
  103. {asimpy-0.4.0 → asimpy-0.4.1}/output/timeout.txt +0 -0
  104. /asimpy-0.4.0/pages/CODE_OF_CONDUCT.md → /asimpy-0.4.1/pages/conduct.md +0 -0
  105. /asimpy-0.4.0/pages/CONTRIBUTING.md → /asimpy-0.4.1/pages/contributing.md +0 -0
  106. {asimpy-0.4.0 → asimpy-0.4.1}/pages/examples.md +0 -0
  107. {asimpy-0.4.0 → asimpy-0.4.1}/pages/index.md +0 -0
  108. /asimpy-0.4.0/pages/LICENSE.md → /asimpy-0.4.1/pages/license.md +0 -0
  109. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/allof.md +0 -0
  110. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/barrier.md +0 -0
  111. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/environment.md +0 -0
  112. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/event.md +0 -0
  113. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/firstof.md +0 -0
  114. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/interrupt.md +0 -0
  115. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/process.md +0 -0
  116. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/resource.md +0 -0
  117. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/simqueue.md +0 -0
  118. {asimpy-0.4.0 → asimpy-0.4.1}/pages/reference/timeout.md +0 -0
  119. {asimpy-0.4.0 → asimpy-0.4.1}/pages/tutorial/01_minimal.md +0 -0
  120. {asimpy-0.4.0 → asimpy-0.4.1}/pages/tutorial/03_interrupt.md +0 -0
  121. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/__init__.py +0 -0
  122. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/_adapt.py +0 -0
  123. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/allof.py +0 -0
  124. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/barrier.py +0 -0
  125. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/environment.py +0 -0
  126. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/event.py +0 -0
  127. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/firstof.py +0 -0
  128. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/interrupt.py +0 -0
  129. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/process.py +0 -0
  130. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/resource.py +0 -0
  131. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/simqueue.py +0 -0
  132. {asimpy-0.4.0 → asimpy-0.4.1}/src/asimpy/timeout.py +0 -0
  133. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/01_minimal/environment.py +0 -0
  134. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/01_minimal/event.py +0 -0
  135. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/01_minimal/example_timeout.py +0 -0
  136. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/01_minimal/process.py +0 -0
  137. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/01_minimal/timeout.py +0 -0
  138. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/02_queue/environment.py +0 -0
  139. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/02_queue/event.py +0 -0
  140. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/02_queue/example_queue.py +0 -0
  141. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/02_queue/process.py +0 -0
  142. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/02_queue/simqueue.py +0 -0
  143. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/02_queue/timeout.py +0 -0
  144. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/03_interrupt/environment.py +0 -0
  145. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/03_interrupt/event.py +0 -0
  146. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/03_interrupt/example_interrupt.py +0 -0
  147. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/03_interrupt/interrupt.py +0 -0
  148. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/03_interrupt/process.py +0 -0
  149. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/03_interrupt/simqueue.py +0 -0
  150. {asimpy-0.4.0 → asimpy-0.4.1}/tutorial/03_interrupt/timeout.py +0 -0
@@ -0,0 +1,15 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: ubuntu-22.04
5
+ tools:
6
+ python: "3.12"
7
+
8
+ python:
9
+ install:
10
+ - method: pip
11
+ path: .
12
+ - requirements: docs/requirements.txt
13
+
14
+ mkdocs:
15
+ configuration: mkdocs.yml
@@ -0,0 +1,33 @@
1
+ # Contributing
2
+
3
+ Contributions are very welcome.
4
+ Please file issues or submit pull requests in our [GitHub repository][repo].
5
+ All contributors will be acknowledged,
6
+ but must abide by our Code of Conduct.
7
+
8
+ ## Setup
9
+
10
+ - `uv venv` (once)
11
+ - `source .venv/bin/activate`
12
+ - `uv sync --extra dev`
13
+
14
+ ## Operations
15
+
16
+ `task --list` displays a list of actions:
17
+
18
+ | action | effect |
19
+ | -------- | |
20
+ | build | build package |
21
+ | check | check code issues |
22
+ | clean | clean up |
23
+ | concat | concatenate files |
24
+ | docs | build documentation |
25
+ | fix | fix code issues |
26
+ | format | format code |
27
+ | lint | run all code checks |
28
+ | examples | regenerate example output |
29
+ | publish | publish using ~/.pypirc credentials |
30
+ | serve | serve documentation |
31
+ | types | check types |
32
+
33
+ [repo]: https://github.com/gvwilson/asimpy
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: asimpy
3
- Version: 0.4.0
3
+ Version: 0.4.1
4
4
  Summary: A simple discrete event simulator using async/await
5
5
  Author-email: Greg Wilson <gvwilson@third-bit.com>
6
6
  Maintainer-email: Greg Wilson <gvwilson@third-bit.com>
@@ -9,7 +9,7 @@ Keywords: discrete event simulation,open source
9
9
  Classifier: License :: OSI Approved :: MIT License
10
10
  Classifier: Operating System :: OS Independent
11
11
  Classifier: Programming Language :: Python :: 3
12
- Requires-Python: >=3.13
12
+ Requires-Python: >=3.12
13
13
  Provides-Extra: dev
14
14
  Requires-Dist: build>=1.4.0; extra == 'dev'
15
15
  Requires-Dist: markdown-include>=0.8.1; extra == 'dev'
@@ -176,7 +176,7 @@
176
176
 
177
177
 
178
178
  <li class="md-nav__item">
179
- <a href="/LICENSE/" class="md-nav__link">
179
+ <a href="/license/" class="md-nav__link">
180
180
 
181
181
 
182
182
 
@@ -203,7 +203,7 @@
203
203
 
204
204
 
205
205
  <li class="md-nav__item">
206
- <a href="/CODE_OF_CONDUCT/" class="md-nav__link">
206
+ <a href="/conduct/" class="md-nav__link">
207
207
 
208
208
 
209
209
 
@@ -230,7 +230,7 @@
230
230
 
231
231
 
232
232
  <li class="md-nav__item">
233
- <a href="/CONTRIBUTING/" class="md-nav__link">
233
+ <a href="/contributing/" class="md-nav__link">
234
234
 
235
235
 
236
236
 
@@ -9,10 +9,10 @@
9
9
 
10
10
 
11
11
 
12
- <link rel="prev" href="../LICENSE/">
12
+ <link rel="prev" href="../license/">
13
13
 
14
14
 
15
- <link rel="next" href="../CONTRIBUTING/">
15
+ <link rel="next" href="../contributing/">
16
16
 
17
17
 
18
18
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../LICENSE/" class="md-nav__link">
188
+ <a href="../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -341,7 +341,7 @@
341
341
 
342
342
 
343
343
  <li class="md-nav__item">
344
- <a href="../CONTRIBUTING/" class="md-nav__link">
344
+ <a href="../contributing/" class="md-nav__link">
345
345
 
346
346
 
347
347
 
@@ -9,7 +9,7 @@
9
9
 
10
10
 
11
11
 
12
- <link rel="prev" href="../CODE_OF_CONDUCT/">
12
+ <link rel="prev" href="../conduct/">
13
13
 
14
14
 
15
15
  <link rel="next" href="../examples/">
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../LICENSE/" class="md-nav__link">
188
+ <a href="../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -248,6 +248,24 @@
248
248
 
249
249
 
250
250
 
251
+ <label class="md-nav__link md-nav__link--active" for="__toc">
252
+
253
+
254
+
255
+ <span class="md-ellipsis">
256
+
257
+
258
+ Contributing
259
+
260
+
261
+
262
+ </span>
263
+
264
+
265
+
266
+ <span class="md-nav__icon md-icon"></span>
267
+ </label>
268
+
251
269
  <a href="./" class="md-nav__link md-nav__link--active">
252
270
 
253
271
 
@@ -265,6 +283,47 @@
265
283
 
266
284
  </a>
267
285
 
286
+
287
+
288
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <label class="md-nav__title" for="__toc">
296
+ <span class="md-nav__icon md-icon"></span>
297
+ Table of contents
298
+ </label>
299
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
300
+
301
+ <li class="md-nav__item">
302
+ <a href="#setup" class="md-nav__link">
303
+ <span class="md-ellipsis">
304
+
305
+ Setup
306
+
307
+ </span>
308
+ </a>
309
+
310
+ </li>
311
+
312
+ <li class="md-nav__item">
313
+ <a href="#operations" class="md-nav__link">
314
+ <span class="md-ellipsis">
315
+
316
+ Operations
317
+
318
+ </span>
319
+ </a>
320
+
321
+ </li>
322
+
323
+ </ul>
324
+
325
+ </nav>
326
+
268
327
  </li>
269
328
 
270
329
 
@@ -816,6 +875,36 @@
816
875
 
817
876
 
818
877
 
878
+ <label class="md-nav__title" for="__toc">
879
+ <span class="md-nav__icon md-icon"></span>
880
+ Table of contents
881
+ </label>
882
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
883
+
884
+ <li class="md-nav__item">
885
+ <a href="#setup" class="md-nav__link">
886
+ <span class="md-ellipsis">
887
+
888
+ Setup
889
+
890
+ </span>
891
+ </a>
892
+
893
+ </li>
894
+
895
+ <li class="md-nav__item">
896
+ <a href="#operations" class="md-nav__link">
897
+ <span class="md-ellipsis">
898
+
899
+ Operations
900
+
901
+ </span>
902
+ </a>
903
+
904
+ </li>
905
+
906
+ </ul>
907
+
819
908
  </nav>
820
909
  </div>
821
910
  </div>
@@ -835,19 +924,73 @@
835
924
  <p>Contributions are very welcome.
836
925
  Please file issues or submit pull requests in our <a href="https://github.com/gvwilson/asimpy">GitHub repository</a>.
837
926
  All contributors will be acknowledged,
838
- but must abide by our <a href="../CODE_OF_CONDUCT/">Code of Conduct</a>.</p>
927
+ but must abide by our Code of Conduct.</p>
928
+ <h2 id="setup">Setup</h2>
839
929
  <ul>
840
- <li>Setup:<ul>
841
930
  <li><code>uv venv</code> (once)</li>
842
931
  <li><code>source .venv/bin/activate</code></li>
843
932
  <li><code>uv sync --extra dev</code></li>
844
933
  </ul>
845
- </li>
846
- <li>Check package: <code>make check</code></li>
847
- <li>Build package: <code>make build</code></li>
848
- <li>Publish package: <code>twine upload --verbose -u __token__ -p your-pypi-access-token dist/*</code></li>
849
- <li>Build documentation: <code>make docs</code></li>
850
- </ul>
934
+ <h2 id="operations">Operations</h2>
935
+ <p><code>task --list</code> displays a list of actions:</p>
936
+ <table>
937
+ <thead>
938
+ <tr>
939
+ <th>action</th>
940
+ <th>effect</th>
941
+ </tr>
942
+ </thead>
943
+ <tbody>
944
+ <tr>
945
+ <td>build</td>
946
+ <td>build package</td>
947
+ </tr>
948
+ <tr>
949
+ <td>check</td>
950
+ <td>check code issues</td>
951
+ </tr>
952
+ <tr>
953
+ <td>clean</td>
954
+ <td>clean up</td>
955
+ </tr>
956
+ <tr>
957
+ <td>concat</td>
958
+ <td>concatenate files</td>
959
+ </tr>
960
+ <tr>
961
+ <td>docs</td>
962
+ <td>build documentation</td>
963
+ </tr>
964
+ <tr>
965
+ <td>fix</td>
966
+ <td>fix code issues</td>
967
+ </tr>
968
+ <tr>
969
+ <td>format</td>
970
+ <td>format code</td>
971
+ </tr>
972
+ <tr>
973
+ <td>lint</td>
974
+ <td>run all code checks</td>
975
+ </tr>
976
+ <tr>
977
+ <td>examples</td>
978
+ <td>regenerate example output</td>
979
+ </tr>
980
+ <tr>
981
+ <td>publish</td>
982
+ <td>publish using ~/.pypirc credentials</td>
983
+ </tr>
984
+ <tr>
985
+ <td>serve</td>
986
+ <td>serve documentation</td>
987
+ </tr>
988
+ <tr>
989
+ <td>types</td>
990
+ <td>check types</td>
991
+ </tr>
992
+ </tbody>
993
+ </table>
851
994
 
852
995
 
853
996
 
@@ -9,7 +9,7 @@
9
9
 
10
10
 
11
11
 
12
- <link rel="prev" href="../CONTRIBUTING/">
12
+ <link rel="prev" href="../contributing/">
13
13
 
14
14
 
15
15
  <link rel="next" href="../reference/allof/">
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../LICENSE/" class="md-nav__link">
188
+ <a href="../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -10,7 +10,7 @@
10
10
 
11
11
 
12
12
 
13
- <link rel="next" href="LICENSE/">
13
+ <link rel="next" href="license/">
14
14
 
15
15
 
16
16
 
@@ -346,7 +346,7 @@
346
346
 
347
347
 
348
348
  <li class="md-nav__item">
349
- <a href="LICENSE/" class="md-nav__link">
349
+ <a href="license/" class="md-nav__link">
350
350
 
351
351
 
352
352
 
@@ -373,7 +373,7 @@
373
373
 
374
374
 
375
375
  <li class="md-nav__item">
376
- <a href="CODE_OF_CONDUCT/" class="md-nav__link">
376
+ <a href="conduct/" class="md-nav__link">
377
377
 
378
378
 
379
379
 
@@ -400,7 +400,7 @@
400
400
 
401
401
 
402
402
  <li class="md-nav__item">
403
- <a href="CONTRIBUTING/" class="md-nav__link">
403
+ <a href="contributing/" class="md-nav__link">
404
404
 
405
405
 
406
406
 
@@ -12,7 +12,7 @@
12
12
  <link rel="prev" href="..">
13
13
 
14
14
 
15
- <link rel="next" href="../CODE_OF_CONDUCT/">
15
+ <link rel="next" href="../conduct/">
16
16
 
17
17
 
18
18
 
@@ -222,7 +222,7 @@
222
222
 
223
223
 
224
224
  <li class="md-nav__item">
225
- <a href="../CODE_OF_CONDUCT/" class="md-nav__link">
225
+ <a href="../conduct/" class="md-nav__link">
226
226
 
227
227
 
228
228
 
@@ -249,7 +249,7 @@
249
249
 
250
250
 
251
251
  <li class="md-nav__item">
252
- <a href="../CONTRIBUTING/" class="md-nav__link">
252
+ <a href="../contributing/" class="md-nav__link">
253
253
 
254
254
 
255
255
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245
 
@@ -185,7 +185,7 @@
185
185
 
186
186
 
187
187
  <li class="md-nav__item">
188
- <a href="../../LICENSE/" class="md-nav__link">
188
+ <a href="../../license/" class="md-nav__link">
189
189
 
190
190
 
191
191
 
@@ -212,7 +212,7 @@
212
212
 
213
213
 
214
214
  <li class="md-nav__item">
215
- <a href="../../CODE_OF_CONDUCT/" class="md-nav__link">
215
+ <a href="../../conduct/" class="md-nav__link">
216
216
 
217
217
 
218
218
 
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <li class="md-nav__item">
242
- <a href="../../CONTRIBUTING/" class="md-nav__link">
242
+ <a href="../../contributing/" class="md-nav__link">
243
243
 
244
244
 
245
245