Repository File Structure¶
The PyMedPhys repository has the following general structure:
pymedphys/ | README.rst | LICENSE | changelog.md | pyproject.toml | ... | |-- docs/ | |-- pymedphys/ | |-- ...
PyMedPhys contains a series of top-level files. These include:
|A text file containing general information on the PyMedPhys
repository with links to important sections. On the PyMedPhys
|A text file that contains a full copy of the license used by PyMedPhys.|
|A text file containing release notes for the PyMedPhys
source code library.
|The poetry configuration file that designates dependencies and other library related details.|
You’ll quickly note from a cursory look through PyMedPhys that there are actually many more top-level files. Most of these help configure specific tasks, such as installation & automated testing. They are probably less critical to understand in detail in order to comprehend PyMedPhys’ structure, so we’ll disregard them for now in the interest of brevity.
(Most of) the rest of PyMedPhys is arranged in the following directories:
|Contains most of PyMedPhys’ documentation. The files within
|The main PyMedPhys package.|