Skip to content
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

Turn generate_neurobagel_example_jsonlds.sh into makefile #412

Open
alyssadai opened this issue Dec 19, 2024 · 2 comments
Open

Turn generate_neurobagel_example_jsonlds.sh into makefile #412

alyssadai opened this issue Dec 19, 2024 · 2 comments
Labels
refactor Simplifying or restructuring existing code or documentation. usability Issue affecting user or developer experience.

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Dec 19, 2024

The script operations may be better handled with a makefile. Mainly because you have to make sure that the script is being run only from the repo root dir (and a bunch of other stuff is also needed). But we're all human, so we might run it from the wrong dir, and then the docker commands are going to create a bunch of root-ownder folders in the repo - which is annoying.

makefile would make this all a lot easier. And it could also do the submodule getting / branching and so on for you. So I suggest we do that. If this is too big a move, let's split this off into its own PR

Also, we should simplify the internal mountpoint from /data/neurobagel/bagel-cli to /data.

Originally posted by @surchs in #410 (comment)

@alyssadai alyssadai added usability Issue affecting user or developer experience. refactor Simplifying or restructuring existing code or documentation. labels Dec 19, 2024
alyssadai added a commit that referenced this issue Feb 4, 2025
@alyssadai alyssadai added the flag:check Issue needs attention before further action label Feb 4, 2025
@alyssadai
Copy link
Contributor Author

Hey @surchs, following up on this issue - I think the original context for this suggestion was to automate the following steps which are currently needed before you can run the script:

# 1. cd into the tests/neurobagel_examples submodule and create a new branch that will contain the updated example files
# 2. Navigate back to the bagel-cli repository root directory and run this script from there to regenerate the example synthetic JSONLD files inside of the tests/neurobagel_examples submodule
# in neurobagel_examples.
# 3. Navigate again to tests/neurobagel_examples and from there, commit the changes, push the changes to the submodule origin, and open a PR there to merge the updated examples.

However, as mentioned today, I think these operations could be integrated into the same existing shell script rather than moving to a Makefile, since the whole script will always need to be run together.

Wdyt?

@surchs
Copy link
Contributor

surchs commented Feb 5, 2025

Hey @alyssadai, that sounds good to me!

@alyssadai alyssadai removed the flag:check Issue needs attention before further action label Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Simplifying or restructuring existing code or documentation. usability Issue affecting user or developer experience.
Projects
Status: No status
Development

No branches or pull requests

2 participants