https://github.com/bamresearch/ctsimu-scenarios
A file format to describe CT scans.
https://github.com/bamresearch/ctsimu-scenarios
ct ctsimu
Last synced: 5 months ago
JSON representation
A file format to describe CT scans.
- Host: GitHub
- URL: https://github.com/bamresearch/ctsimu-scenarios
- Owner: BAMresearch
- License: apache-2.0
- Created: 2021-12-05T10:43:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T21:24:56.000Z (almost 3 years ago)
- Last Synced: 2026-01-17T02:03:07.269Z (5 months ago)
- Topics: ct, ctsimu
- Language: Python
- Homepage: https://bamresearch.github.io/ctsimu-scenarios/
- Size: 18.9 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ctsimu-scenarios
A file format to describe CT scans.
This is the source code of the file format documentation. You need the Python package [Sphinx](https://www.sphinx-doc.org) to compile it.
The [Read the Docs theme](https://sphinx-rtd-theme.readthedocs.io) is required. To install it, use:
pip install sphinx_rtd_theme
Additionally the [sphinxcontrib-bibtex](https://sphinxcontrib-bibtex.readthedocs.io/en/latest/quickstart.html) extension is required. To install it, use:
pip install sphinxcontrib-bibtex
The references.bib file can be edited with a reference manager like [JabRef](https://www.jabref.org/).
## 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)