Skip to content

Commit 05fb84c

Browse files
thomashampsonpeterfpeterson
authored andcommitted
Follow conda capitalization standards (mantidproject#39522)
1 parent f6a7f0b commit 05fb84c

28 files changed

+76
-76
lines changed

CMakePresets.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"configurePresets": [
99
{
1010
"name": "conda",
11-
"description": "Inherited by all Conda-based, non-hidden presets",
11+
"description": "Inherited by all conda-based, non-hidden presets",
1212
"hidden": true,
1313
"binaryDir": "${sourceDir}/build",
1414
"generator": "Ninja",
@@ -28,7 +28,7 @@
2828
},
2929
{
3030
"name": "unix-debug",
31-
"description": "Inherited by all Unix-like presets for debugging. Overrides Conda CXX flags for debugging",
31+
"description": "Inherited by all Unix-like presets for debugging. Overrides conda CXX flags for debugging",
3232
"hidden": true,
3333
"cacheVariables": {
3434
"CMAKE_CXX_FLAGS_DEBUG": "-g -Og",

buildconfig/CMake/WindowsSetup.cmake

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ else()
5656
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Zm${VISUALSTUDIO_COMPILERHEAPLIMIT}")
5757
endif()
5858

59-
# Define a new configuration for debugging with Conda. Crucially it must link to the MSVC release runtime but we switch
59+
# Define a new configuration for debugging with conda. Crucially it must link to the MSVC release runtime but we switch
6060
# off all optimzations
6161
set(_conda_debug_cfg_name DebugWithRelRuntime)
6262
string(TOUPPER ${_conda_debug_cfg_name} _conda_debug_cfg_name_upper)
@@ -91,7 +91,7 @@ set(CMAKE_CONFIGURATION_TYPES
9191
)
9292
message(
9393
STATUS
94-
"Detected a build with Conda on Windows. Resetting available build configurations to ${CMAKE_CONFIGURATION_TYPES}"
94+
"Detected a build with conda on Windows. Resetting available build configurations to ${CMAKE_CONFIGURATION_TYPES}"
9595
)
9696

9797
# HDF5 uses threads::threads target

buildconfig/Jenkins/Conda/download-and-install-mambaforge

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ if [ ! -f $EXPECTED_MAMBA_EXE ]; then
5555
elif [ -x "$(which wget)" ] ; then
5656
wget $URL
5757
else
58-
echo "Could not download Conda as wget and curl are not installed."
58+
echo "Could not download conda as wget and curl are not installed."
5959
exit 1
6060
fi
6161
fi
@@ -75,7 +75,7 @@ if [ ! -f $EXPECTED_MAMBA_EXE ]; then
7575
if [[ $OSTYPE == 'msys'* ]]; then
7676
# Replace all / with \ for windows batch support before passing in $EXPECTED_MAMBAFORGE_PATH
7777
cmd.exe //C "START /wait "" $MAMBAFORGE_SCRIPT_NAME /InstallationType=JustMe /S /D=${EXPECTED_MAMBAFORGE_PATH////\\}"
78-
# The paths in the Conda environment shell environments are Windows style. Convert to cygwin style
78+
# The paths in the conda environment shell environments are Windows style. Convert to cygwin style
7979
cp $EXPECTED_MAMBAFORGE_PATH/etc/profile.d/conda.sh{,.orig}
8080
cat $EXPECTED_MAMBAFORGE_PATH/etc/profile.d/conda.sh.orig | \
8181
sed -e '/^export\ CONDA_/s/\\/\//g' | \

dev-docs/source/CodeCoverage.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
========================
2-
Generating Code Coverage
2+
Generating code coverage
33
========================
44

55
.. contents::
@@ -16,14 +16,14 @@ GCC and LLVM have tooling built in to allow a developer to view the code coverag
1616

1717
This will work for native C++ code and any code executed via Python, as the instrumentation is compiled into the binary output. Gcovr will also filter out any non-project code automatically.
1818

19-
Coverage on Conda
19+
Coverage on conda
2020
#################
2121

22-
Since the move to `conda`, `GCC` is installed through the conda package `gxx_linux-64`. This conda package does NOT include `gcov`, required to assess code coverage. `gcov` is not currently available on `conda`, so you will need to ensure that `gcov` can be instead found on your system, and that this version of `gcov` is the same version as the `GCC` compiler we install using `conda`. If this is not the case, errors will be raised during the generation of coverage data.
22+
Since the move to conda, `GCC` is installed through the conda package `gxx_linux-64`. This conda package does NOT include `gcov`, required to assess code coverage. `gcov` is not currently available on conda, so you will need to ensure that `gcov` can be instead found on your system, and that this version of `gcov` is the same version as the `GCC` compiler we install using conda. If this is not the case, errors will be raised during the generation of coverage data.
2323

2424
As `gcov` is packaged with `GCC`, you will need to install `GCC` on your system. You can typically do this using the `apt` package manager. If an appropriate version of `GCC` is not available for your OS you will unfortunately have to build it from source: https://gcc.gnu.org/wiki/InstallingGCC
2525

26-
C++ Specific Notes
26+
C++ specific notes
2727
##################
2828

2929
The coverage target(s) do not run the tests automatically. Users must either run the test(s) or file(s) they are interested in manually for data to be produced by the tooling.

dev-docs/source/CondaPackageManager.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Conda Package Manager
77
.. contents::
88
:local:
99

10-
Mantid uses `Conda <https://docs.conda.io/en/latest/>`_ as its package management system. This document gives a
11-
developer overview on how we use the Conda package manager, including tips on how to debug dependency issues, and
10+
Mantid uses `conda <https://docs.conda.io/en/latest/>`_ as its package management system. This document gives a
11+
developer overview on how we use the conda package manager, including tips on how to debug dependency issues, and
1212
our policy towards using ``pip`` packages (it is strongly discouraged).
1313

1414
Creating Environments
@@ -48,12 +48,12 @@ Finding a broken dependency
4848
---------------------------
4949

5050
The nightly pipelines can sometimes fail for obscure reasons, seemingly unrelated to the changes made within
51-
Mantid. In this case, it is probable that a Conda dependency has updated, and the new update is "Broken"
51+
Mantid. In this case, it is probable that a conda dependency has updated, and the new update is "Broken"
5252
(if it is a minor or patch update) or no longer compatible with Mantid (if it is a major update).
5353

5454
To find the dependency which has changed, you can run the ``tools/Jenkins/dependency_spotter.py`` script. This
5555
script takes two Jenkins build numbers, and optionally the OS label, the pipeline name, and the name of the file to
56-
compare. It will then output the changes in Conda package versions used in the two builds, if there are any. A
56+
compare. It will then output the changes in conda package versions used in the two builds, if there are any. A
5757
few examples on how to use it:
5858

5959
.. code-block:: sh
@@ -71,7 +71,7 @@ Another useful command for investigating the dependencies of specific packages i
7171
Fixing a broken dependency
7272
--------------------------
7373

74-
After identifying the Conda dependency and version which is causing the unwanted behaviour, there are several
74+
After identifying the conda dependency and version that is causing the unwanted behaviour, there are several
7575
options we can take to fix the issue. The following options are in order of preference:
7676

7777
1. Raise an issue in the dependencies `feedstock <https://conda-forge.org/docs/maintainer/adding_pkgs.html#feedstock-repository-structure>`_
@@ -91,18 +91,18 @@ follows:
9191

9292
.. code-block:: none
9393
94-
We strongly encourage PyPi dependencies be built into Conda packages and uploaded to conda-forge. PyPi packages
95-
will not be automatically installed into our Mantid Conda environments, and should instead be installed by
94+
We strongly encourage PyPi dependencies be built into conda packages and uploaded to conda-forge. PyPi packages
95+
will not be automatically installed into our Mantid conda environments, and should instead be installed by
9696
users of the software, if required.
9797
98-
We do not want to include pip packages as dependencies in our Conda recipes because there is no guarantee of
99-
compatibility between the two package managers. In the past, attempting to resolve compatibile package versions
98+
We do not want to include pip packages as dependencies in our conda recipes because there is no guarantee of
99+
compatibility between the two package managers. In the past, attempting to resolve compatible package versions
100100
when two package managers are involved have caused broken Mantid installations. Furthermore, the original
101-
motivation for moving towards Conda was so that we had a unified package manager rather than using several
101+
motivation for moving towards conda was so that we had a unified package manager rather than using several
102102
different systems or mechanisms. Including pip packages in our dependencies would be a backwards step.
103103

104104
The other solution we considered was installing our pip dependencies downstream within our DAaaS workspace
105105
configuration repository. We decided against this because it feels like bad practise to have a formalised
106106
way of installing dependencies of a software in a way which is completely detached. The prevailing message is
107-
this: please only use Conda packages. We provide :ref:`pip install instructions <pip-install-ref>` for users if
107+
this: please only use conda packages. We provide :ref:`pip install instructions <pip-install-ref>` for users if
108108
they would like to take the risk.

dev-docs/source/GettingStarted/GettingStarted.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Getting Started
1818
Environment Setup
1919
#################
2020

21-
With the addition of Conda to our workflow we at present have two different methods of Getting Started with mantid development.
22-
Therefore you can choose which method to setup with (We recommend Conda as it will be the only supported
21+
With the addition of conda to our workflow we at present have two different methods of Getting Started with mantid development.
22+
Therefore you can choose which method to setup with (We recommend conda as it will be the only supported
2323
method eventually).
2424

2525
* :ref:`GettingStartedCondaWindows`

dev-docs/source/GettingStarted/GettingStartedCondaLinux.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _GettingStartedCondaLinux:
22

33
===========================
4-
Develop with Conda on Linux
4+
Develop with conda on Linux
55
===========================
66

77
Install Git
@@ -58,7 +58,7 @@ Building and debugging with CLion
5858
---------------------------------
5959
Please follow the Linux related instructions on :ref:`this page <clion-ref>`.
6060

61-
CMake Conda variables
61+
CMake conda variables
6262
-----------------------
6363
The `CONDA_BUILD` parameter is used to customise our installation, which is required when we are using the conda-build tool to build and package Mantid. This option can be passed to CMake on the command line using -DCONDA_BUILD=True.
6464

dev-docs/source/GettingStarted/GettingStartedCondaOSX.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _GettingStartedCondaOSX:
22

33
===========================
4-
Develop with Conda on MacOS
4+
Develop with conda on MacOS
55
===========================
66

77
Install `Git <https://git-scm.com/>`_
@@ -42,7 +42,7 @@ How to build
4242
* To build Mantid Workbench use: ``ninja``
4343
* To build Unit Tests use: ``ninja AllTests``
4444

45-
CMake Conda variables
45+
CMake conda variables
4646
-----------------------
4747
The ``CONDA_BUILD`` parameter is used to customise our installation, which is required when we are using the conda-build tool to build and package Mantid.
4848
This option can be passed to CMake on the command line using ``-DCONDA_BUILD=True``.

dev-docs/source/GettingStarted/GettingStartedCondaWindows.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _GettingStartedCondaWindows:
22

33
=============================
4-
Develop with Conda on Windows
4+
Develop with conda on Windows
55
=============================
66

77
Install `Visual Studio 2022 Community Edition <https://visualstudio.microsoft.com/downloads/>`_
@@ -39,7 +39,7 @@ Install `Mambaforge <https://github.com/conda-forge/miniforge/releases>`_
3939
-------------------------------------------------------------------------
4040

4141
* Choose the latest version of ``Mambaforge-Windows-x86_64.exe``
42-
* Run your downloaded ``Mambaforge-Windows-x86_64.exe`` and work through the installer until it finishes. In order to make it easier later on, check the box that adds Conda to your path.
42+
* Run your downloaded ``Mambaforge-Windows-x86_64.exe`` and work through the installer until it finishes. In order to make it easier later on, check the box that adds conda to your path.
4343

4444
Setup the mantid conda environment
4545
----------------------------------
@@ -95,6 +95,6 @@ Building and debugging with CLion
9595
---------------------------------
9696
Please follow the Windows related instructions on :ref:`this page <clion-ref>`.
9797

98-
CMake Conda variables
98+
CMake conda variables
9999
---------------------
100100
The `CONDA_BUILD` parameter is used to customise our installation, which is required when we are using the conda-build tool to build and package Mantid. This option can be passed to CMake on the command line using -DCONDA_BUILD=True.

dev-docs/source/GettingStarted/GettingStartedNoneConda.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _GettingStartedNoneConda:
22

33
=====================
4-
Develop without Conda
4+
Develop without conda
55
=====================
66

77
Environment

0 commit comments

Comments
 (0)