From 545e58d473971f5a2bf02f48eb22e7c68bf632aa Mon Sep 17 00:00:00 2001 From: Martin Weise <martin.weise@tuwien.ac.at> Date: Mon, 15 Jul 2024 05:29:49 +0200 Subject: [PATCH] Updated docs and docker files --- .docs/examples/lute-data.md | 34 ++++++++++++++++++ .docs/examples/xps.md | 47 ------------------------- .docs/images/logos/univie_small.png | Bin 0 -> 2725 bytes dbrepo-analyse-service/Dockerfile | 2 +- dbrepo-auth-service/Dockerfile | 8 ++--- dbrepo-data-service/Dockerfile | 12 +++---- dbrepo-metadata-service/Dockerfile | 8 ++--- dbrepo-search-db/Dockerfile | 2 +- dbrepo-search-service/Dockerfile | 2 +- dbrepo-storage-service/init/Dockerfile | 2 +- dbrepo-ui/Dockerfile | 2 +- mkdocs.yml | 1 + 12 files changed, 54 insertions(+), 66 deletions(-) create mode 100644 .docs/examples/lute-data.md delete mode 100644 .docs/examples/xps.md create mode 100644 .docs/images/logos/univie_small.png diff --git a/.docs/examples/lute-data.md b/.docs/examples/lute-data.md new file mode 100644 index 0000000000..bceecd9052 --- /dev/null +++ b/.docs/examples/lute-data.md @@ -0,0 +1,34 @@ +--- +author: Martin Weise +--- + +## tl;dr + +tbd + +## Description + +The main aim of the E-LAUTE project is to create a novel form of music edition: an "open knowledge platform" in which +musicology, music practice, music informatics and literary studies intertwine and transform the "classic" edition into a +space of interdisciplinary and discipline-specific work. + +In order to create a comprehensive, complete modern scholarly edition, the E-LAUTE project synchronises high technology +informatics in the fields of encoding, linking, recognition (OMR) and automatic transcription with manual music +transcription and musical performance practice. We consider recordings of lute music a conceptual component of the +edition. + +## Solution + +tbd + +## DBRepo Features + +- [x] Data preservation of historic data +- [x] Subset exploration +- [x] External visualization of the database + +## Acknowledgement + +This work was part of a cooperation with the University of Vienna in the context of [E-LAUTE](https://e-laute.info/). + +<img src="../../images/logos/univie_small.png" width=100 /> \ No newline at end of file diff --git a/.docs/examples/xps.md b/.docs/examples/xps.md deleted file mode 100644 index 08abcd35bc..0000000000 --- a/.docs/examples/xps.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -author: Martin Weise ---- - -## tl;dr - -[:fontawesome-solid-database: Dataset](https://dbrepo1.ec.tuwien.ac.at/database/27/info){ .md-button .md-button--primary target="_blank" } -[:simple-jupyter: Notebook](https://binder.science.datalab.tuwien.ac.at/v2/git/https%3A%2F%2Fgitlab.tuwien.ac.at%2Ffairdata%2Fxps/HEAD){ .md-button .md-button--secondary target="_blank" } - -## Description - -X-ray Photoelectron Spectroscopy (XPS) is one of the most used methods in material sciences. Irradiation of solid -materials with X-ray radiation kicks out electrons from atoms that are near the atomic nucleus. With XPS data being -highly reproducible once machine parameters are known and understood, the demand for creating a comprehensive database -connecting material properties to compositions via XPS spectra becomes evident. - -## Solution - -We read XPS data from the VAMAS-encoded format and inserted it into a -[database schema](https://gitlab.tuwien.ac.at/fairdata/xps/-/blob/e17860399b1b109c72b01888766f37193dde5870/sql/create_schema.sql) -that captures the VAMAS-schema. It can then be read using the [Python Library](../../api/python). - -<figure markdown> -{ .img-border } -<figcaption>Figure 1: Jupyter Notebook accessing data on DBRepo using the Python Library.</figcaption> -</figure> - -Using the DataFrame representation of the Python Library and the [`plotly`](https://pypi.org/project/plotly/) library, -we can visualize the ordinate values directly in the Jupyter Notebook. - -<figure markdown> -{ .img-border } -<figcaption>Figure 2: Plot of ordinate values encoded within the experiment block.</figcaption> -</figure> - -## DBRepo Features - -- [x] Data preservation of VAMAS-encoded XPS data -- [x] Subset exploration -- [x] External visualization of the database -- [x] Replication of experiments using only open-source software - -## Acknowledgement - -This work was part of a cooperation with the [Institute of Applied Physics](http://www.iap.tuwien.ac.at/). - -<img src="../../images/logos/iap.jpeg" width=100 /> \ No newline at end of file diff --git a/.docs/images/logos/univie_small.png b/.docs/images/logos/univie_small.png new file mode 100644 index 0000000000000000000000000000000000000000..320ae9de895106118db0cc2453317375db04e179 GIT binary patch literal 2725 zcmeAS@N?(olHy`uVBq!ia0y~yU`SzLV36iuV_;zDnx^Hzz`(#*9OUlAc=M!AJp%&+ zXMsm#F#`j)FbFd;%$g&?z`*6@>EaktG3RYmWkKjwSv$`b4iAM(4LOWU)L0{rY~U2S z#^T74;>csYXZq{}A6|}5R;`FrYF38=O6ROvy4L1a=JKoWd=~y)eC^^jzvX2cFRzT9 z`>uNV*6z#Se!qLad*}DNdvtP|a?hVJ-}$`!yzTRQ_si>UR~D|D{H#*WP(p+C8q@5C z-UDe03$qt7NpOF8le3Teme9)8jdA%ms@`5d&${kqk`JH30abstzdHNpd&CxAd+oUM z=K<XVu?LD07!3F{Skk&0lD;ly{N5>Z>fBS|-S>r7)*aw{a96y1q2K+7d=FR?BGi*l zHC#Th^;JKM9lwtC>a7bdv^p>wI9>~6`x00$VIVzY)$7*{vm58`ieoZitUdp_**d#3 zMD9ae!gbf^#jndf7~&b)R@gJ$xW24r@>xc^hr)?}ogPRgZ2Wc8!SX{xe&NhnCsr^< zE&ZW+KqY~vfPDk2#>C&Z7Jb~Zr1St&f?UDmV{xT|qLZ#abl)SWJMq=S-Sao>7pmZu z5TBU(`@Q71&0p?WzWUB$$5CUw_;)LlIm7D4ssy$I^8n5z4aZC7Z%kG&U|+$?$F%&( zraS@3Y?I@R3*y=3r>u_+6Pe6Ep{D1Ni*^Ceif{HBGU1$4PSxJ!J5w|}=%eY1hNu5x zuD$17!`{bKeXDHyUFpT8KjVbA-e%`~&(OypeOqL@hcDABljmQ9-q<((etNDgTjqYg z^aqv=@)A;!lRww;{%GCz*(^RTJpB0*4<Uni$64!+PZnJhs*r!RbZ<xI6xB7?c8KlV z-kzenoyl|8Zk`qq#{X<#N1r@yxZZfY;XC8*#^a6qyJzI|{?_`ip-l2=JR{rjXHu+t zmc&Lf?cuny+SKc+f7gz$QQJL>?b&lCM9*6PQ9gS!L$J~P`UTf4)tt65hfdOGvU{L? zOXr2k2j+xT&mx#?xc993`kZxIAj6&23BEzkm~N-4ZVjsF{l%T4c>3#hu8goXk&J7m zOD{fp<z>~&NFk@6&udbDZ<;)%p5w>L{mF}4ZhS3Cf44}<Onhqb1;f>zOX4o-o$I@^ zd{X^0i5bpLeq9Ib&i(m6@x+hSF%uMBIXBknelVZ@Zc|1n>%@Q24f2-9cwQG98(Mmn zM+QV}O*)`>wAuE6#>tm;+cc|Jh1u+k3^Va$2|byWVc6VYZCWO{L9{}B!n{|dz8>B_ z`^0`22h3@l5VvW<clTq#E6-aO+Z&st=jQk=TUuZA>=Tnyn#;TS(>AH?sCdn%_;!Bc zsz1IDR<7fy+&yJhkH+2r!{&q4ss@pa^CYk27Wtkza!;$s?9|=07w6nINuT`gygj#5 z+;`C_ddn;SA8q}ppmOBbmbUx9t#AL@+|X~$y+(S=wQ`rB2JtUG*)0<motV?ZT7Px( z@;OI0zKiZSnHjpdk?p|_ou4l4Egqe^x9(n+)K>975hTar#$7BT9;P)dL}S8p?~m1u zcjqlVy!pwxNmXg(>@92dIkdzu*DzZsbXWE#KiFEGz4cnm^}y3E9Vgc_Z)1uVvGhN& z$x8jm9hK%E<)+^SCVnmoZ+SDFJ8RnQNS-I28~e2!#4E#^Cv14V*Wjpb@cxLrSDp_F zCx&Ziue>Iuvd#aA^ZKjocO`=l_&#^(ILXIs&z5F&`g^hJ{8d|Dou4(~L*2X+Kjy8o zR!Z6PYmIl^+sQ)bE-trjd2=amzq?oJtlRNo&X&zKw{5;2Kb5-izSimtfyymfVc+sU zuL(<B6riX5$XIpa^v9?F2>sx>V7_VfJR5$e8Fl|o&z!%m|HRJ4`*pabq^i?qZN6eM z`ShaOyQ8i*M%OH3=3ZGK_W0SV_%;9Tov2ydINzP)q0JeE`WH>J+_>&&F-bi=G$V4Y zpoDXl$+VkcE2qq!U|M*FXX3GlEy34<^_ZqJ{Wd8p^pX5p#5})j%`V;Ez0Ykp68BVu z?JkIT6Swi*$DLy7g{@ytI2WnDY>CkN<C#8FQa4Zb!xnC)nrf%E?t;40PU)pwlbhyS ztPY<MXZ$#M)mfI5ZS!tF(OI|U*ZImY_chZuO;$?jnquj)ae-IMmJ?G=PZzzIBsZb8 zpl_zsexGSBH@POd{p1qQf3|q$cKy;Yk+_#S#!>>(*YAh3y^o%6xWeFY&6)r1+a}+( zeRtyHxu(xX;<hqdwyJMCn{TvBZP~Fihtzf}@NTcxk;pGtbHiEk@-3<K^oXCo#I6}| zMk?7l#6LL3G4YN|@RvJF6b>gvotl-nIp(6(-=~F~*+SQ3Sc@{NOY2w9yZbQG;rY#L zPLXW$V^x&$zUwe6TY4vPohlDw{?c<&a!UKIjMThOF>hV!ZcN}=605n$;||C4xMH45 z#(VS%rrB)pdog$79`CCn&J`LKf$zE<cg)vmP1%r?{wr$njslOAoUR?)S$BmiZ`zca zy8G!lwNt;mE{U11{;}_|V$80Z-pv*U25Qd@PiSh+d-tH=iCnqC<BP!u#L`*s1&SYA zK4tT&*;kE?m*rb}SI++yd+q5Z8|&^*OI}#Lee*BK?BJBGL196QEsD2$Ji1X><gOYg zQN8Yi&gol<-H9?g?|08<h`#nQ`grl;lArE#Wu2!Se{#H5=&e<h1fTfE_SlMo>FP({ z2hacbfd5>QNN@_<C(#4;4QIt&cRs)LByPnQ!C$vEe)f3qXija)7PZfC^_hB{dFQV9 zMd@iTe+CIwd5CSYe$0KN^6F<jogGC>-x#0k^WLPg{Qcia-2C4cwU{vPFLFG<|2%Dh zn_9V&!jn+(|A8lUo(7BiEPQ@@(#a*kJdsQ9`lb3$J{0-jY+ys&g1K?aEP^zd+`T^v ze>r0_(PjIwoSbd*W>5aes>AT_SnJQ<TJ^`HCOp>6Sop-oHMhq`Tt@HNDO<zRJ?A6Y zL>~mE&%B%<ct~f3d(L0ue{DPF%n~{N>bIlj^smm%9$8o7@9lRDbIjHVs^MH!xXU;# zXHEJm*EfO_52h?|KXz32K+*H}h0_Y>Oyt(ua`$a|!k@PfQ>WL($O#;pGIcAXf9cGq zYi<rj=2<+Pm4=4}|GqpuaRO81NuSvJFCx2cziG{U7o)lBB=_rSY>^I2lUydJtO<1M zG)YV9wvM^8Np7Cx$B12*!Y7>EEV`ib$=OA(6W;7>m>~1F_9W|m$CS9^9GUw2bvO%) ze4iHiZsAzAXYH=Ez;MN*?Emiw$k>FPE?U+-rIqP*|3oFj^_Rsrn0)O&a9x&rX~4Oj z7v<-;c5U34zR0lU-CI+8kL~k!Z~wQil7n+r`cXw@^ZpAnxA}$oRJa`68MegmhX1tL zi&SN&M?ad#xp||^&aK~OhAvCfdue%e(wvStrKhxIHH^GC`V;LQ>Gb-Z%Bni~sW0=) z?EVS6cJ0zRzv_+Zrmmp3pNx)5%5}?#a{g{za?C%lhI37;-rD-@;{HqWSl@X~R{bl# zY}+rf3w3||j#sI^`5tuUhrx%)oz~|K_ip{|`_K68^M`+|cm16=eUazRlJGMNA`(A; zpBP)@eEaD&iQ=k?Fb*TZ2P+N!hpzBC`1jJ^^H=JVKfif?Gd1W>(azObtR=fv?cLPz zz~NKuJke=uEH~|nd-(tDoLT9|6?A^^RfkoYpYpxhJ%@QyNB8&oi2u%S?H9h$dN}V} S{{;pH1_n=8KbLh*2~7ailr;qa literal 0 HcmV?d00001 diff --git a/dbrepo-analyse-service/Dockerfile b/dbrepo-analyse-service/Dockerfile index 980c11cd19..97b181c76e 100644 --- a/dbrepo-analyse-service/Dockerfile +++ b/dbrepo-analyse-service/Dockerfile @@ -1,5 +1,5 @@ FROM python:3.11-alpine -MAINTAINER Martin Weise <martin.weise@tuwien.ac.at> +LABEL org.opencontainers.image.authors="martin.weise@tuwien.ac.at" RUN apk add bash curl diff --git a/dbrepo-auth-service/Dockerfile b/dbrepo-auth-service/Dockerfile index 8caf422498..47fabff4ed 100644 --- a/dbrepo-auth-service/Dockerfile +++ b/dbrepo-auth-service/Dockerfile @@ -1,6 +1,6 @@ ###### FIRST STAGE ###### -FROM keycloak/keycloak:24.0 as config -MAINTAINER Martin Weise <martin.weise@tuwien.ac.at> +FROM keycloak/keycloak:24.0 AS config +LABEL org.opencontainers.image.authors="martin.weise@tuwien.ac.at" # Enable health and metrics support ENV KC_HEALTH_ENABLED=true @@ -17,12 +17,12 @@ COPY ./server.keystore ./conf/server.keystore RUN /opt/keycloak/bin/kc.sh build ###### SECOND STAGE ###### -FROM redhat/ubi9-minimal as binary +FROM redhat/ubi9-minimal AS binary RUN microdnf update -y && microdnf install -y curl-minimal libcurl-minimal ###### THIRD STAGE ###### -FROM keycloak/keycloak:21.0 as runtime +FROM keycloak/keycloak:21.0 AS runtime COPY --from=config /opt/keycloak/ /opt/keycloak/ COPY --from=binary /usr/lib64 /usr/lib64 diff --git a/dbrepo-data-service/Dockerfile b/dbrepo-data-service/Dockerfile index 806908a8af..bd6d428695 100644 --- a/dbrepo-data-service/Dockerfile +++ b/dbrepo-data-service/Dockerfile @@ -1,10 +1,10 @@ ###### FIRST STAGE ###### -FROM dbrepo-metadata-service:build as dependency -MAINTAINER Martin Weise <martin.weise@tuwien.ac.at> +FROM dbrepo-metadata-service:build AS dependency +LABEL org.opencontainers.image.authors="martin.weise@tuwien.ac.at" ###### SECOND STAGE ###### -FROM maven:3-openjdk-17 as build -MAINTAINER Martin Weise <martin.weise@tuwien.ac.at> +FROM maven:3-openjdk-17 AS build +LABEL org.opencontainers.image.authors="martin.weise@tuwien.ac.at" COPY ./pom.xml ./ @@ -21,8 +21,8 @@ COPY ./services ./services RUN mvn clean package -DskipTests ###### THIRD STAGE ###### -FROM amazoncorretto:17-alpine3.19 as runtime -MAINTAINER Martin Weise <martin.weise@tuwien.ac.at> +FROM amazoncorretto:17-alpine3.19 AS runtime +LABEL org.opencontainers.image.authors="martin.weise@tuwien.ac.at" RUN apk add --no-cache curl bash jq diff --git a/dbrepo-metadata-service/Dockerfile b/dbrepo-metadata-service/Dockerfile index 1a37bf7e7e..74e8204373 100644 --- a/dbrepo-metadata-service/Dockerfile +++ b/dbrepo-metadata-service/Dockerfile @@ -1,6 +1,6 @@ ###### FIRST STAGE ###### -FROM maven:3-openjdk-17 as build -MAINTAINER Martin Weise <martin.weise@tuwien.ac.at> +FROM maven:3-openjdk-17 AS build +LABEL org.opencontainers.image.authors="martin.weise@tuwien.ac.at" COPY ./pom.xml ./ COPY ./api/pom.xml ./api/ @@ -27,8 +27,8 @@ COPY ./test ./test RUN mvn clean install -DskipTests ###### SECOND STAGE ###### -FROM amazoncorretto:17-alpine3.19 as runtime -MAINTAINER Martin Weise <martin.weise@tuwien.ac.at> +FROM amazoncorretto:17-alpine3.19 AS runtime +LABEL org.opencontainers.image.authors="martin.weise@tuwien.ac.at" RUN apk add --no-cache curl bash jq diff --git a/dbrepo-search-db/Dockerfile b/dbrepo-search-db/Dockerfile index 083994b580..c597506dca 100644 --- a/dbrepo-search-db/Dockerfile +++ b/dbrepo-search-db/Dockerfile @@ -1,4 +1,4 @@ -FROM opensearchproject/opensearch:2.10.0 as runtime +FROM opensearchproject/opensearch:2.10.0 AS runtime USER root diff --git a/dbrepo-search-service/Dockerfile b/dbrepo-search-service/Dockerfile index 875a9f28bd..35427f81a4 100644 --- a/dbrepo-search-service/Dockerfile +++ b/dbrepo-search-service/Dockerfile @@ -1,5 +1,5 @@ FROM python:3.11-alpine -MAINTAINER Martin Weise <martin.weise@tuwien.ac.at> +LABEL org.opencontainers.image.authors="martin.weise@tuwien.ac.at" RUN apk add --no-cache curl bash jq diff --git a/dbrepo-storage-service/init/Dockerfile b/dbrepo-storage-service/init/Dockerfile index 72b080d6ce..4a35534fb2 100644 --- a/dbrepo-storage-service/init/Dockerfile +++ b/dbrepo-storage-service/init/Dockerfile @@ -1,4 +1,4 @@ -FROM chrislusf/seaweedfs:3.59 as runtime +FROM chrislusf/seaweedfs:3.59 AS runtime WORKDIR /app diff --git a/dbrepo-ui/Dockerfile b/dbrepo-ui/Dockerfile index d7b63d8f89..33f62cce86 100644 --- a/dbrepo-ui/Dockerfile +++ b/dbrepo-ui/Dockerfile @@ -24,7 +24,7 @@ COPY ./nuxt.config.ts ./nuxt.config.ts RUN bun run build -FROM oven/bun:1.0.26-alpine as runtime +FROM oven/bun:1.0.26-alpine AS runtime ARG APP_VERSION="latest" ARG COMMIT="" diff --git a/mkdocs.yml b/mkdocs.yml index 45e06cbe38..9bb4588f27 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -49,6 +49,7 @@ nav: - Hazard Data: examples/hazard.md - Industry 4.0 Power Data: examples/power.md - Survey Data: examples/survey.md + - Lute Data: examples/lute-data.md - Music-ML Data: examples/music.md - Transportation Data: examples/transportation.md - XPS Data: examples/xps-data.md -- GitLab