Skip to content

Updates and formats Building ISIS#190

Merged
Kelvinrr merged 24 commits into
DOI-USGS:mainfrom
jrcain-usgs:isis-dev-building-flags
Jun 1, 2026
Merged

Updates and formats Building ISIS#190
Kelvinrr merged 24 commits into
DOI-USGS:mainfrom
jrcain-usgs:isis-dev-building-flags

Conversation

@jrcain-usgs

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

Copy link
Copy Markdown
Contributor

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.

@acpaquette acpaquette left a comment

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.

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

Comment thread docs/how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md Outdated
You will need to modify your `~/.bashrc` as follows:
***Executables Directory:***
Executables are placed in `build/bin` (and linked in `$CONDA_PREFIX/bin`).
For Example, to use ddt (with `$ISISROOT` set to the build directory):

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I dont think ddt is that common of a tool, I think we should be like "to use the ddt debugger with a local build" (otherwise someone might be confused), or remove the mention of ddt.

@Kelvinrr
Kelvinrr merged commit 4970d7e into DOI-USGS:main Jun 1, 2026
3 checks passed
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.

3 participants