-
Notifications
You must be signed in to change notification settings - Fork 1
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
Running the example phantom recon #14
Comments
@felixhorger yes, we only ever tested this from inside the GIRFReco environment, and didn't adjust the example after package-ization during the JOSS pre-review. I will adjust as per your final suggestion. |
There are multiple ways of distributing the examples. Option 1: Use the same environment as
|
#9 will be addressed here as well |
We have elected to pursue Option 1 for reducing the dependencies and also to streamline the running of the examples. This will achieve the target of a significantly more lightweight GIRFReco.jl. We will make this change and close this issue once completed. |
We have implemented Option 1 into #4, and so are closing this. |
I think the example for phantom recons needs some improvement. @cncastillo please can you cross-check that this is the right way to do it.
If I understood it correctly, there are two options that work as it is now, firstly I could activate the
Project.toml
ofGIRFReco.jl
by usingjulia --project=/path/to/GIRFReco.jl joss_example.jl
(but that's not in the description), or I could have all the required dependencies installed into my main environment (which is active if I run it as described in the readme).I think both are not optimal because you want the example to have a similar setup to when someone is using your package, but self-contained and with minimal effort to get it running. The first method activates the wrong environment, and the second requires the user to manually install packages they might not want/need into their main environment. I suggest setting up an environment which you ship with the
joss_example.jl
, i.e. in the examples folder you run] activate .
, and then add all the dependencies for the example and add theProject.toml
to the git repo. The instructions then need to be adjusted to saycd .../examples/
, then]
andactivate
,instantiate
, thenjulia --project=. joss_example.jl
.The text was updated successfully, but these errors were encountered: