Repository navigation
Developer Guide
This page summarizes the current project structure and points developers to the detailed Wiki pages.
- Java 26
- Maven wrapper included in the repository
- Git
- Platform runtime assets for release packaging
./mvnw test # JUnit 5 unit tests + JaCoCo coverage (target/site/jacoco/)
./mvnw clean packageThe packaged JAR is created under target/. CI uploads coverage to Codecov on every push.
The tests include whole runs of the five-isolate example (EndToEndTest), which use the BLAST+ and BBTools under runtime/ (Git LFS) and are skipped without them. ./mvnw test fails when line coverage drops below the floors set in pom.xml (the whole project, and the pcr, util and pipeline packages); without the tools, run ./mvnw test -Djacoco.haltOnFailure=false. For a quicker build, -DexcludedGroups=end-to-end -Djacoco.haltOnFailure=false leaves out the whole runs (about 40 s instead of 2 minutes; the coverage floors need them).
java -jar target/insilicoPCR.jar -h| Area | Entry point |
|---|---|
| Dispatcher | ca.canada.inspection.dispatchpcr.Dispatcher |
| GUI | ca.canada.inspection.insilicopcr.MainRun |
| CLI | ca.canada.inspection.dispatchpcr.CliConfig |
| Pipeline | ca.canada.inspection.pipeline.InSilicoPcrPipeline |
The dispatcher starts the GUI when no arguments are provided and starts the CLI pipeline when command-line arguments are present. The packages and how they depend on each other are on Architecture.
Keep the README compact. Use the GitHub Wiki as the user-facing manual.
The docs/wiki/ directory is the source-controlled mirror of the GitHub Wiki. Publish it with scripts/docs/publish-wiki.sh (see Publishing to GitHub Wiki).
When adding a feature, update:
- README only if the feature changes the project overview or quick start
- relevant Wiki page for full details
- SVG diagrams under
docs/assets/if the architecture, workflow, or release process changes - screenshots under
docs/assets/(gui/,report/,gel/,tutorial/) when the GUI, the reports or the gel change
Potential future work:
- improve synthetic gel export options