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

[question] Are large files only required for tests, or also required at build and run-time ? #8912

Closed
yurivict opened this issue Jul 11, 2024 · 4 comments · Fixed by #8914
Closed

Comments

@yurivict
Copy link

At one point the README says:

[...] large files used to build GATK, and test files required to run the test suite [...]

Does this mean that all production builds should contain large files?
Are they used by some gatk commands?

The README is just not clear about this.

@yurivict yurivict changed the title [question] Are large files only required for tests, or also required for build and run-time ? [question] Are large files only required for tests, or also required at build and run-time ? Jul 11, 2024
@droazen
Copy link
Contributor

droazen commented Jul 11, 2024

@yurivict The large files under src/main/resources/large/ are required to build GATK, since they are packaged inside the GATK jar and used by tools at runtime. These are things like ML models and native C/C++ libraries used for acceleration of certain tools.

The large files under src/test/resources/large/, on the other hand, are only required by the test suite when running tests.

Hope this clears things up!

@yurivict
Copy link
Author

This clarifies it, thank you!

Could you please also add this information to the README so that anybody would be able to read this in the future?

@droazen
Copy link
Contributor

droazen commented Jul 12, 2024

@yurivict There is a note in the README about this in the "Building GATK4" section:

Note that you must have a full git clone in order to build GATK, including the git-lfs files in src/main/resources. The zipped source code alone is not buildable.

However, I will edit it to make it clearer.

@ghost
Copy link

ghost commented Aug 2, 2024

.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants