-
Notifications
You must be signed in to change notification settings - Fork 506
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Restructure folders #254
Restructure folders #254
Conversation
Restructure folders to better catalog the scripts and jupyter notebooks not part of the pyradiomics core code. Example scripts, notebooks and example parameter files are now stored in the directory tree under `examples`. The `bin` folder now only contains some scripts useful for developers and for specific use cases. These include a script to generate and add a baseline for a new featureclass and a script to resample a mask to the image geometry. Update the references to these files where necessary in the documentation.
5ea7a9b
to
46d8e62
Compare
@Radiomics/developers Can this be merged? It also fixes a bug in the circleci testing, so I want to merge this PR first. |
@@ -377,7 +377,7 @@ | |||
"name": "python", | |||
"nbconvert_exporter": "python", | |||
"pygments_lexer": "ipython2", | |||
"version": "2.7.12" | |||
"version": "2.7.11" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if this is needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, but that is changed automatically if you run the notebooks. I'll revert this change.
Would it make sense to have:
and also:
Last, would it make sense to have all example in one folder ...
|
Is there a good reason not to have notebooks as a top-level folder? |
Overall, I don't have any major concerns, feel free to merge! |
Probably, something like I also wonder if the example should be numbered in the order they should be reviewed by a new user ..
|
In that case I would suggest to move helloFeatureClass should be moved to the back as it represents a non-standard use of pyradiomics |
46d8e62
to
9ef7ea0
Compare
Update the config.yml to test the hello* notebooks and the PyRadiomicsExample.ipynb, which more extensively tests different parts of the toolbox and different ways the toolbox can be used.
9ef7ea0
to
b2bbe1c
Compare
I restructured the folder, so that now notebooks is a separate top-level folder, and have one folder for all examples. Seeing as the input CSV as it is structured for the batch examples is also the way it is structured for the batch script for the commandline, I moved the scripts showing how to build such a CSV from a dataset to the Moreover, I provided a test csv file to allow users to test the batch scripts using the test data included in the repository. This file is included with the examples. Finally updated the notebooks some to better reflect recent changes. |
I did not number the examples, as only the |
Restructure directory tree to make a better distinction between additional scripts for special uses in PyRadiomics (
bin
folder) and examples (examples
folder)switch testing of notebooks to make use of the Hello* and PyRadiomicsExample Notebooks, which more extensively use the different parts of the toolbox and represent multiple ways in which the toolbox can be used.