diff --git a/.github/workflows/docs-generation.yml b/.github/workflows/docs-generation.yml new file mode 100644 index 0000000..34ea182 --- /dev/null +++ b/.github/workflows/docs-generation.yml @@ -0,0 +1,26 @@ +name: Docs Generation + +on: [push] + +jobs: + build_and_test: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - name: install latex and generate documents + run: | + sudo apt-get install -y texlive-latex-base texlive-latex-extra texlive-extra-utils poppler-utils pdf2svg + cd ./ContinousIntegration + chmod +x ./run_generate_docs.sh + ./run_generate_docs.sh + mkdir result + cp ../Documentation/Diagrams/*.png ../Documentation/Diagrams/*.svg result + + - name: Archive latex docs + uses: actions/upload-artifact@v2 + if: always() + with: + name: Latex Documents + path: ./ContinousIntegration/result \ No newline at end of file diff --git a/Documentation/Diagrams/creatediagrams.sh b/ContinousIntegration/run_generate_docs.sh old mode 100755 new mode 100644 similarity index 81% rename from Documentation/Diagrams/creatediagrams.sh rename to ContinousIntegration/run_generate_docs.sh index ec1dcd8..6c168b3 --- a/Documentation/Diagrams/creatediagrams.sh +++ b/ContinousIntegration/run_generate_docs.sh @@ -1,5 +1,7 @@ #!/bin/bash +cd ../Documentation/Diagrams/ + # generate .png from all .tex in current directory for filename_with_extension in *.tex @@ -17,6 +19,10 @@ do pdfcrop $filename.pdf $filename-tmp.pdf pdftoppm -png -r 800 $filename-tmp.pdf $filename + + # convert .tex to .png + + pdf2svg $filename-tmp.pdf $filename.svg all done rm *.aux *.log *.pdf diff --git a/Documentation/Diagrams/ArchitectureOverview.svg b/Documentation/Diagrams/ArchitectureOverview.svg new file mode 100644 index 0000000..15de562 --- /dev/null +++ b/Documentation/Diagrams/ArchitectureOverview.svg @@ -0,0 +1,676 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/Diagrams/HostArchitecture.svg b/Documentation/Diagrams/HostArchitecture.svg new file mode 100644 index 0000000..cb6e7ed --- /dev/null +++ b/Documentation/Diagrams/HostArchitecture.svg @@ -0,0 +1,160 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Documentation/Diagrams/UARTFrameFormat.svg b/Documentation/Diagrams/UARTFrameFormat.svg new file mode 100644 index 0000000..ef06659 --- /dev/null +++ b/Documentation/Diagrams/UARTFrameFormat.svg @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/README.md b/README.md index c4cb939..293fba2 100755 --- a/README.md +++ b/README.md @@ -8,14 +8,14 @@ When air's atoms are hit by radioactive particles, an ion-pair is produced. Ions They will try to "meet each other" (I don't know how to explain it) thus creating a current. This current can be measured. The current is proportional to amount of ion-pairs. Amount of ion-pairs is proportional to radioactivity level. -![architecture](https://raw.githubusercontent.com/RobertGawron/IonizationChamber/master/Documentation/Pictures/pcb_01_09_2019.jpg) +![picture of device](https://raw.githubusercontent.com/RobertGawron/IonizationChamber/master/Documentation/Pictures/pcb_01_09_2019.jpg) ## System architecture It is designed in a way that the device can work remotely, e.g. no connection via USB cable to user’s PC is needed. -![architecture](https://raw.githubusercontent.com/RobertGawron/IonizationChamber/master/Documentation/Diagrams/ArchitectureOverview-1.png) + Remarks: * Amplifier has three stages (first stage is transimpedance amplifier, not FET like most projects use). diff --git a/Software/DataAcquisition/README.md b/Software/DataAcquisition/README.md index c6f0fcb..98ba292 100644 --- a/Software/DataAcquisition/README.md +++ b/Software/DataAcquisition/README.md @@ -9,8 +9,7 @@ ## Architecture -![architecture of the component](https://raw.githubusercontent.com/RobertGawron/IonizationChamber/master/Documentation/Diagrams/HostArchitecture-1.png) - + ## Collecting measurements