Skip to content

Updates and formats Building ISIS#190

Open
jrcain-usgs wants to merge 15 commits intoDOI-USGS:mainfrom
jrcain-usgs:isis-dev-building-flags
Open

Updates and formats Building ISIS#190
jrcain-usgs wants to merge 15 commits intoDOI-USGS:mainfrom
jrcain-usgs:isis-dev-building-flags

Conversation

@jrcain-usgs
Copy link
Copy Markdown
Contributor

@jrcain-usgs jrcain-usgs commented Feb 21, 2026

The Building ISIS doc seemed to be kind of outdated and contain some things that don't work anymore. I tried to streamline the first half at least, based on my recent builds.

For Example:

  • -DJP2KFLAG is OFF by default
  • Some old flags no longer work
  • The install directory is never used, everything happens in the build directory
  • Added a cmake flag example
  • No one uses the shared internal environments/the setisis script under `For Internal Devs' anymore, right?

Licensing

This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

  • I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

Copy link
Copy Markdown
Contributor

@acpaquette acpaquette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks great! A couple smaller things to address then this should be good

@@ -18,9 +18,9 @@ find isis/src/*/apps/ -regex '.*/tsts' | sed 's:[^/]*$::'

Apps that need to be refactored only have *app-name.xml* and *main.cpp*, other than the *Makefile* and other possible folders (like `assets` and `tsts`). Take a look at the [bandtrim](https://github.com/DOI-USGS/ISIS3/tree/dev/isis/src/base/apps/bandtrim) app for example. In comparison, apps that have been updated to fit the gtest suite will have *app-name.xml*, *app-name.cpp*, *app-name.h*, and *main.cpp*, like the [campt](https://github.com/DOI-USGS/ISIS3/tree/dev/isis/src/base/apps/campt) app.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to the last comment, all changes look good. But bandtrim has been converted to a callable app. We might want to pick another example. An option would be to point to bandtrim before it was converted. See here:
https://github.com/DOI-USGS/ISIS3/tree/a28654ac754852f188be4c9710d001172ba459ac/isis/src/base/apps/bandtrim


```sh
# From inside your build directory (or wherever cmake was run)
ninja install
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would avoid running ninja/make install, without an install directory this will place the binaries into the conda environment. This applies to all of these sections that mention building with either make or ninja

Generally, it's better to just run ninja and then add $ISISROOT/bin/ to your $PATH

The full command would look something like export PATH=$ISISROOT/bin:$PATH

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 this pull request may close these issues.

2 participants