https://github.com/bamresearch/artist-handbook
User guide for the radiographic simulator aRTist.
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.5%) to scientific vocabulary
Keywords
Repository
User guide for the radiographic simulator aRTist.
Basic Info
- Host: GitHub
- Owner: BAMresearch
- License: other
- Language: TeX
- Default Branch: main
- Homepage: https://bamresearch.github.io/aRTist-handbook/
- Size: 49.9 MB
Statistics
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
aRTist Handbook
User guide for the radiographic simulator aRTist. Find the readable version here:
https://bamresearch.github.io/aRTist-handbook/
This is the source code of the documentation for aRTist. You need the Python package Sphinx to compile it.
The Read the Docs theme is required. To install it, use:
pip install sphinx_rtd_theme
Additionally the sphinxcontrib-bibtex extension is required. To install it, use:
pip install sphinxcontrib-bibtex
The references.bib file can be edited with a reference manager like JabRef.
Compile and deploy
The source files are all located in the source folder. To create the HTML documentation and store it in the build folder, run
make html
To create a PDF version using LaTeX, run
make latexpdf
To build everything anew from scratch, delete the build folder or run
make clean
Github Pages expects the HTML documentation in a folder called docs. You can run the deploy script to automatically copy the content from build/html to docs and create the necessary .nojekyll file.
deploy.bat (Windows)
./deploy.sh (Linux)
Owner
- Name: Bundesanstalt für Materialforschung und -prüfung
- Login: BAMresearch
- Kind: organization
- Email: oss@bam.de
- Location: Berlin/Germany
- Website: www.bam.de
- Repositories: 36
- Profile: https://github.com/BAMresearch
German Federal scientific research institute for materials testing and research
GitHub Events
Total
- Push event: 3
Last Year
- Push event: 3