Skip to content

Commit 66289d0

Browse files
committed
Update README.md
1 parent 394cccf commit 66289d0

File tree

1 file changed

+9
-30
lines changed

1 file changed

+9
-30
lines changed

README.md

Lines changed: 9 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,47 +10,26 @@ Jupyter notebooks can be accessed via the services
1010
- **static** version using **nbviewer**: https://nbviewer.org/github/spatialaudio/data-driven-audio-signal-processing-exercise/blob/dev/index.ipynb
1111
- **sources** (tex, ipynb) at: https://github.com/spatialaudio/data-driven-audio-signal-processing-exercise
1212

13-
Jupyter notebooks with rendered **outputs** can be viewed at https://nbviewer.org/github/spatialaudio/data-driven-audio-signal-processing-exercise/blob/main/index.ipynb
14-
1513
## Versions / Tags
1614

1715
- [v0.1](https://github.com/spatialaudio/data-driven-audio-signal-processing-exercise/releases/tag/v0.1) for winter term 2021/22, initial version
1816
- [v0.2](https://github.com/spatialaudio/data-driven-audio-signal-processing-exercise/releases/tag/v0.2) for winter term 2022/23
1917
- [v0.3](https://github.com/spatialaudio/data-driven-audio-signal-processing-exercise/releases/tag/v0.3) for winter term 2023/24, many beamer tex slides added, CI
20-
- TBD for winter term 2024/25
18+
- [v0.4](https://github.com/spatialaudio/data-driven-audio-signal-processing-exercise/releases/tag/v0.4) winter term 2024/25, smaller mods due to API changes, PCA example on exam grades, slides
19+
- [v0.5](https://github.com/spatialaudio/data-driven-audio-signal-processing-exercise/releases/tag/v0.5) winter term 2025/26, TBD
2120

2221
## Branch Conventions
2322

24-
- the **default branch** of the repository is `dev` used for development
25-
- all notebook outputs in `dev` branch are cleared for convenient diff handling
26-
- `main` branch contains notebooks with rendered outputs, which is maintained from time to time
23+
- the **default branch** of the repository is `dev` and this is used for development
24+
- the `dev` branch contains notebooks with cleared outputs for convenient diff handling
25+
- the `main` branch contains notebooks with rendered outputs, which is maintained from time to time
2726
- do **not** rely on `main` branch as this is hard reset from time to time
2827
- probably in future we rename `main` to somewhat less confusing
2928

30-
## Anaconda Environment for Local Usage
31-
32-
The [Anaconda distribution](https://www.anaconda.com/distribution/) is a convenient solution to install a required environment, i.e. to have access to a Jupyter Notebook renderer with a Python interpreter on a personal computer. It is very likely that a very recent installation of Anaconda already delivers most of the required standard packages just using the `base` environment. It is however good practice to create a dedicated environment for each project. So, for this tutorial we might use a `myddasp` (or whatever name works for us) environment. We might consider the following install routine:
33-
34-
- clone the repo to local machine (if not already available)
35-
- `git clone [email protected]:spatialaudio/data-driven-audio-signal-processing-exercise.git` (via SSH) or
36-
- `git clone https://github.com/spatialaudio/data-driven-audio-signal-processing-exercise.git` (via https) or
37-
- get a zip file from current `dev` commit via https://github.com/spatialaudio/data-driven-audio-signal-processing-exercise/archive/refs/heads/dev.zip
38-
- get into the folder where the exercises are located, e.g. `cd my_ddasp_folder`
39-
- in the subfolder `.binder` the `environment.yml` can be used to create a dedicated conda `myddasp` environment as
40-
- `conda env create -f environment.yml --force`
41-
- (we can remove this environment with `conda env remove --name myddasp`)
42-
- activate this environment with `conda activate myddasp`
43-
- this should also have installed sound / audio related libraries using pip
44-
- `pip install pyloudnorm==0.1.0`
45-
- we might check this with `pip list`
46-
- Jupyter notebook renderer needs to know our dedicated environment:
47-
`python -m ipykernel install --user --name myddasp --display-name "myddasp"`
48-
- we might want to archive the actually installed package versions by
49-
- `python -m pip list > detailed_packages_list_pip.txt` and
50-
- `conda env export --no-builds > detailed_packages_list_conda.txt`
51-
- start a Jupyter lab environment via a local server instance by `jupyter lab`
52-
- start the landing page `index.ipynb` of the tutorial
53-
- make sure that the notebooks we want to work with are using our dedicated kernel `myddasp`
29+
## Python Environment
30+
- the `pyproject.toml` contains the project info
31+
- assuming we use uv for Python, packaging and environment handling a dedicated environment can be cerated with `uv sync`
32+
5433

5534
## Authorship
5635

0 commit comments

Comments
 (0)