Skip to content

Commit 960314e

Browse files
committed
Latest version of BO tutorial
0 parents  commit 960314e

17 files changed

+19117
-0
lines changed

.gitignore

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Flug archives
2+
*.tar.zst
3+
*.json
4+
5+
# Byte-compiled / optimized / DLL files
6+
__pycache__/
7+
*.py[cod]
8+
*$py.class
9+
10+
# C extensions
11+
*.so
12+
13+
# Distribution / packaging
14+
.Python
15+
build/
16+
develop-eggs/
17+
dist/
18+
downloads/
19+
eggs/
20+
.eggs/
21+
lib/
22+
lib64/
23+
parts/
24+
sdist/
25+
var/
26+
wheels/
27+
pip-wheel-metadata/
28+
share/python-wheels/
29+
*.egg-info/
30+
.installed.cfg
31+
*.egg
32+
MANIFEST
33+
34+
# PyInstaller
35+
# Usually these files are written by a python script from a template
36+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
37+
*.manifest
38+
*.spec
39+
40+
# Installer logs
41+
pip-log.txt
42+
pip-delete-this-directory.txt
43+
44+
# Unit test / coverage reports
45+
htmlcov/
46+
.tox/
47+
.nox/
48+
.coverage
49+
.coverage.*
50+
.cache
51+
nosetests.xml
52+
coverage.xml
53+
*.cover
54+
*.py,cover
55+
.hypothesis/
56+
.pytest_cache/
57+
58+
# Translations
59+
*.mo
60+
*.pot
61+
62+
# Django stuff:
63+
*.log
64+
local_settings.py
65+
db.sqlite3
66+
db.sqlite3-journal
67+
68+
# Flask stuff:
69+
instance/
70+
.webassets-cache
71+
72+
# Scrapy stuff:
73+
.scrapy
74+
75+
# Sphinx documentation
76+
docs/_build/
77+
78+
# PyBuilder
79+
target/
80+
81+
# Jupyter Notebook
82+
.ipynb_checkpoints
83+
84+
# IPython
85+
profile_default/
86+
ipython_config.py
87+
88+
# pyenv
89+
.python-version
90+
91+
# pipenv
92+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
94+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
95+
# install all needed dependencies.
96+
#Pipfile.lock
97+
98+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
99+
__pypackages__/
100+
101+
# Celery stuff
102+
celerybeat-schedule
103+
celerybeat.pid
104+
105+
# SageMath parsed files
106+
*.sage.py
107+
108+
# Environments
109+
.env
110+
.venv
111+
env/
112+
venv/
113+
ENV/
114+
env.bak/
115+
venv.bak/
116+
117+
# Spyder project settings
118+
.spyderproject
119+
.spyproject
120+
121+
# Rope project settings
122+
.ropeproject
123+
124+
# mkdocs documentation
125+
/site
126+
127+
# mypy
128+
.mypy_cache/
129+
.dmypy.json
130+
dmypy.json
131+
132+
# Pyre type checker
133+
.pyre/
134+
135+
# virtual environment
136+
*_env/
137+
*-train-data/
138+
# model
139+
wandb/
140+
models/
141+
# slurm_log/

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Numerical Methods of Accelerator Physics
2+
3+
MSc lecture at TU Darmstadt, etit, TEMF by Adrian Oeftiger in 2022/23.
4+
5+
Fourteenth part of a jupyter notebook lecture series, guest lecture held by Dr. Andrea Santamaria Garcia on 10.02.2023.
6+
7+
Find the rendered HTML slides [here](https://aoeftiger.github.io/TUDa-NMAP-14/).
8+
9+
---
10+
11+
## Run online
12+
13+
Run this notebook talk online, interactively on mybinder.org:
14+
15+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/aoeftiger/TUDa-NMAP-14/v1.0)
16+
17+
The `lecture.ipynb` notebook will work out-of-the-box.
18+
19+
---
20+
21+
## Run on TU Darmstadt jupyterhub
22+
23+
If you have a TU ID, access the [local TU Darmstadt jupyterhub](https://tu-jupyter-i.ca.hrz.tu-darmstadt.de/) using your TU ID.
24+
25+
A possible way to upload and run this lecture repository is the following:
26+
27+
1. Open a terminal by clicking on the top right "New" -> "Terminal".
28+
29+
2. A new tab opens with a terminal, click into the black area and enter (copy&pasting):
30+
31+
``` bash
32+
wget https://github.com/aoeftiger/TUDa-NMAP-14/archive/refs/heads/main.zip
33+
unzip main.zip
34+
cd TUDa-NMAP-14-main
35+
```
36+
37+
3. You have downloaded, unzipped and entered the lecture repository. As a last step, install the dependencies:
38+
39+
``` bash
40+
export TMPDIR="`pwd`"
41+
pip install -r requirements_noversions.txt --prefix="`pwd`"/requirements
42+
```
43+
44+
Close the terminal tab and open the `lecture.ipynb` notebook inside the repository directory on the jupyterhub main page.
45+
46+
---
47+
48+
## Run locally
49+
50+
The notebook can of course also be run on your local computer using your own jupyter notebook server. Install such an environment e.g. via the extensive [Anaconda distribution](https://www.anaconda.com/products/distribution), the minimalistic [Miniconda distribution](https://docs.conda.io/en/main/miniconda.html) or the extremely fast [Mamba package manager](https://mamba.readthedocs.io/en/latest/). (The order indicates preference by simplicity in installation and usage.)
51+
52+
You may find all required packages in the `requirements.txt` file.

0 commit comments

Comments
 (0)