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

Docs: warn about default variables set by conda #5466

Open
wants to merge 1 commit into
base: development
Choose a base branch
from

Conversation

EZoni
Copy link
Member

@EZoni EZoni commented Nov 15, 2024

Adding a warning about conda setting default environment variables when installing CMake, as discussed during the developer meeting.

It will be displayed at the onde of the conda section (https://warpx.readthedocs.io/en/latest/install/dependencies.html#conda-linux-macos-windows):

Screenshot from 2024-11-15 12-39-42

@EZoni EZoni added the component: documentation Docs, readme and manual label Nov 15, 2024
@RemiLehe
Copy link
Member

In the documentation: could you add the command line that a user should type in order to clear the variable?

@RemiLehe RemiLehe self-assigned this Nov 19, 2024
Comment on lines +124 to +125
.. warning::
When you install CMake in a conda environment, conda sets several environment variables, e.g., ``CXXFLAGS``, to default values that are specific to the conda environment. Such values are concatenated to the values set by WarpX during buildsystem generation. In order to avoid unintended side effects (e.g., compiling with ``-O2`` instead of ``-O3``), please consider clearing ``CXXFLAGS`` (and/or other relevant variables) before generating the buildsystem and compiling.
Copy link
Member Author

Choose a reason for hiding this comment

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

@RemiLehe Does this look good to you?

Suggested change
.. warning::
When you install CMake in a conda environment, conda sets several environment variables, e.g., ``CXXFLAGS``, to default values that are specific to the conda environment. Such values are concatenated to the values set by WarpX during buildsystem generation. In order to avoid unintended side effects (e.g., compiling with ``-O2`` instead of ``-O3``), please consider clearing ``CXXFLAGS`` (and/or other relevant variables) before generating the buildsystem and compiling.
.. warning::
When you install CMake in a conda environment, conda sets several environment variables, e.g., ``CXXFLAGS``, to default values that are specific to the conda environment. Such values are concatenated to the values set by WarpX during buildsystem generation. In order to avoid unintended side effects (e.g., compiling with ``-O2`` instead of ``-O3``), please consider clearing ``CXXFLAGS`` and/or other relevant variables (e.g., via ``export CXXFLAGS=""``) before generating the buildsystem and compiling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Docs, readme and manual
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants