diff --git a/docker/.dockerignore b/.dockerignore old mode 100755 new mode 100644 similarity index 100% rename from docker/.dockerignore rename to .dockerignore diff --git a/docker/Dockerfile b/Dockerfile old mode 100755 new mode 100644 similarity index 100% rename from docker/Dockerfile rename to Dockerfile diff --git a/README.md b/README.md index 5a270a82e2e8f6adcd37ac99282495cab150b583..16c05df4f1c470b953b7e21ad1c176b3f3ded4ee 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ If you have already downloaded/cloned the package yourself you can use `python - Please file an issue if any of these instructions does not work. ## Documentation -Some of the development of this package took place during a course taught at the II. Institute of Physics at RWTH Aachen University in the winter semester 2022/23. Targeting applied research topics too specific for lectures but too general for lab courses, several modules intended for self-learning were developed, one of which focuses on "characterizing and avoiding noise and interference in instrumentation". The material can be found here: +Some of the development of this package took place during a course taught at the II. Institute of Physics at RWTH Aachen University in the winter semester 2022/23. Targeting applied research topics too specific for lectures but too general for lab courses, several modules intended for self-learning were developed, one of which focuses on "characterizing and avoiding noise and interference in instrumentation". The material can be found here: - [Part 1](https://iffmd.fz-juelich.de/s/6sxq2OgNO), - [Part 2](https://iffmd.fz-juelich.de/s/7LQ7xCCNJ). @@ -67,7 +67,7 @@ Make sure the dependencies are installed via ```sh python -m pip install -e .[doc] ``` -in the top-level directory. +in the top-level directory. To check if everything works for a clean install (requires hatch to be installed), run ```sh @@ -86,5 +86,44 @@ or to check if everything works for a clean install (requires hatch to be instal python -m hatch run tests:run ``` + +### Docker + +0. Make sure docker is installed and running: + 1. `pamac install docker docker-buildx` + 2. `(sudo) docker buildx install` + 2. `(sudo) systemctl status docker` + + Example output: + + ```sh + ● docker.service - Docker Application Container Engine + Loaded: loaded (/usr/lib/systemd/system/docker.service; disabled; preset: disabled) + Active: active (running) since Tue 2025-02-11 20:09:55 CET; 1 week 1 day ago + Invocation: 609d5a409daf4e99b7b3b8da9305776d + TriggeredBy: ● docker.socket + Docs: https://docs.docker.com + Main PID: 54128 (dockerd) + Tasks: 22 + Memory: 38.8M (peak: 1.2G, swap: 21.3M, swap peak: 23.9M) + CPU: 1min 2.133s + CGroup: /system.slice/docker.service + └─54128 /usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock + ``` + +1. Build the docker image: + ```sh + (sudo) docker build -t pyspeck-dev . + ``` +2. Run the image... + 1. ... either running the tests and exiting: + ```sh + (sudo) docker run --rm pyspeck-dev + ``` + 2. ... or entering an interactive console: + ```sh + (sudo) docker run --rm -it pyspeck-dev /bin/bash + ``` + ## Releases Releases on Gitlab, PyPI, and Zenodo are automatically created and pushed whenever a commit is tagged matching [CalVer](https://calver.org/) in the form `vYYYY.MM.MICRO` or `vYYYY.0M.MICRO`. diff --git a/docker/README.md b/docker/README.md deleted file mode 100644 index 019ce764c6834b57bf65ec1322f4fb63ca19a2f7..0000000000000000000000000000000000000000 --- a/docker/README.md +++ /dev/null @@ -1,39 +0,0 @@ - -Docker Instructions -= - -0. Make sure docker is installed and running: - 1. `pamac install docker docker-buildx` - 2. `(sudo) docker buildx install` - 2. `(sudo) systemctl status docker` - - Example output: - - ```sh - ● docker.service - Docker Application Container Engine - Loaded: loaded (/usr/lib/systemd/system/docker.service; disabled; preset: disabled) - Active: active (running) since Tue 2025-02-11 20:09:55 CET; 1 week 1 day ago - Invocation: 609d5a409daf4e99b7b3b8da9305776d - TriggeredBy: ● docker.socket - Docs: https://docs.docker.com - Main PID: 54128 (dockerd) - Tasks: 22 - Memory: 38.8M (peak: 1.2G, swap: 21.3M, swap peak: 23.9M) - CPU: 1min 2.133s - CGroup: /system.slice/docker.service - └─54128 /usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock - ``` - -1. Build the docker image: - ```sh - (sudo) docker build -t pyspeck-dev . - ``` -2. Run the image... - 1. ... either running the tests and exiting: - ```sh - (sudo) docker run --rm pyspeck-dev - ``` - 2. ... or entering an interactive console: - ```sh - (sudo) docker run --rm -it pyspeck-dev /bin/bash - ``` \ No newline at end of file