Skip to content

Commit

Permalink
DX: freeze TR-019 notebook output (#207)
Browse files Browse the repository at this point in the history 
* DOC: add execution time table
* DOC: add remark about Julia language server
* DX: freeze TR-019 notebook output
* FIX: switch to wiki or link to VIM
  https://github.com/ComPWA/compwa-org/actions/runs/6297756039/job/17095325451?pr=204
* MAINT: exclude executing all reports in the range `TR-01*`
* MAINT: update Julia notebook kernel
  • Loading branch information
@redeboer
redeboer authored Sep 25, 2023
1 parent 1b626fe commit cf9e1ad
Show file tree
Hide file tree
Showing 4 changed files with 114 additions and 18 deletions.
10 changes: 1 addition & 9 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -321,15 +321,7 @@ def print_once(message: str) -> None:
"report/006*",
"report/008*",
"report/009*",
"report/010*",
"report/011*",
"report/012*",
"report/013*",
"report/014*",
"report/015*",
"report/016*",
"report/017*",
"report/018*",
"report/01*",
"report/020*",
"report/021*",
"report/022*",
Expand Down
22 changes: 21 additions & 1 deletion docs/develop.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,26 @@ Pkg.instantiate()
See {doc}`/report/019` for an example.
:::

Additionally, you can install a [Language Server](https://jupyterlab-lsp.readthedocs.io/en/latest/Language%20Servers.html) for Julia in Jupyter Lab. To do so, run:

::::{tab-set}
:::{tab-item} Shell

```shell
julia -e 'import Pkg; Pkg.add("LanguageServer")'
```

:::
:::{tab-item} Julia

```julia
using Pkg
Pkg.add("LanguageServer")
```

:::
::::

## Collaboration

The source code of all ComPWA repositories is maintained with [Git](https://git-scm.com)
Expand Down Expand Up @@ -892,7 +912,7 @@ especially the case for [VSCode](#visual-studio-code).

We are open to other code editors as well. An example would be maintaining a
[local vimrc](https://github.com/embear/vim-localvimrc) for users who prefer
[VIM](https://www.vim.org). Other IDEs we'd like to support are
[VIM](<https://en.wikipedia.org/wiki/Vim_(text_editor)>). Other IDEs we'd like to support are
[PyCharm](https://www.jetbrains.com/pycharm), [Atom](https://atom.io),
[IntelliJ with Python](https://www.jetbrains.com/help/idea/plugin-overview.html#b370507b).
So we'll gladly integrate your editor settings where possible as you
Expand Down
95 changes: 87 additions & 8 deletions docs/report/019.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,20 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"metadata": {
"tags": [
"keep_output"
]
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Hello world!\n"
]
}
],
"source": [
"println(\"Hello world!\")"
]
Expand All @@ -78,8 +90,60 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"metadata": {
"tags": [
"keep_output"
]
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
" \n",
" \n",
" \n",
" ** \n",
" ****** \n",
" ******** \n",
" ****** \n",
" ******** ** * \n",
" *** ***************** \n",
" ************************ *** \n",
" **************************** \n",
" ****************************** \n",
" ****************************** \n",
" ************************************ \n",
" * ********************************** \n",
" ** ***** * ********************************** \n",
" *********** ************************************ \n",
" ************** ************************************ \n",
" *************************************************** \n",
" ***************************************************** \n",
" *********************************************************************** \n",
" ***************************************************** \n",
" *************************************************** \n",
" ************** ************************************ \n",
" *********** ************************************ \n",
" ** ***** * ********************************** \n",
" * ********************************** \n",
" ************************************ \n",
" ****************************** \n",
" ****************************** \n",
" **************************** \n",
" ************************ *** \n",
" *** ***************** \n",
" ******** ** * \n",
" ****** \n",
" ******** \n",
" ****** \n",
" ** \n",
" \n",
" \n",
" \n"
]
}
],
"source": [
"function mandelbrot(a)\n",
" z = 0\n",
Expand Down Expand Up @@ -107,7 +171,11 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"metadata": {
"tags": [
"remove-output"
]
},
"outputs": [],
"source": [
"using Pkg\n",
Expand All @@ -118,7 +186,11 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"metadata": {
"tags": [
"remove-output"
]
},
"outputs": [],
"source": [
"using Images\n",
Expand Down Expand Up @@ -161,19 +233,26 @@
" \n",
"mandelbrot()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"![](https://github.com/ComPWA/compwa-org/assets/29308176/f8e604b9-b37c-4b5a-8114-91627da93d37)"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Julia 1.9.2",
"display_name": "Julia 1.9.3",
"language": "julia",
"name": "julia-1.9"
},
"language_info": {
"file_extension": ".jl",
"mimetype": "application/julia",
"name": "julia",
"version": "1.9.2"
"version": "1.9.3"
}
},
"nbformat": 4,
Expand Down
5 changes: 5 additions & 0 deletions docs/reports.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,8 @@ well.
:hidden:
report/*
```

````{dropdown} Execution times
```{nb-exec-table}
```
````

0 comments on commit cf9e1ad

Please sign in to comment.