Merge pull request #58 from oglez/master

Merging latest additions and improvements in preparation for the April'25 CAT Hackathon

Author: ttedeschi

.github/workflows/cd.yml

@@ -17,7 +17,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: hynek/build-and-inspect-python-package@v1
+      - uses: hynek/build-and-inspect-python-package@v2
 
   publish:
     needs: [dist]
@@ -28,10 +28,9 @@ jobs:
     if: github.event_name == 'release' && github.event.action == 'published'
 
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: Packages
           path: dist
 
       - uses: pypa/gh-action-pypi-publish@release/v1
-

.github/workflows/softwarecheck.yml

@@ -24,11 +24,11 @@ jobs:
       - name: Checking_Cpp_compilation
         run: |
           cd src
-          echo '{gROOT->LoadMacro("cmsstyle.C++");}' > hola.C
+          echo '{gROOT->LoadMacro("cmsstyle.C++");}' > compiling.C
 
           dnf install -y root
           echo 'ROOT VERSION='`root-config --version`
-          root -q hola.C
+          root -q compiling.C
           ls -lh cmsstyle_C.so
 #
   py2-job:

README.md

@@ -9,14 +9,53 @@ Python:
 ```python
 pip install cmsstyle
 ```
+Once this is done, the ``import cmsstyle`` should work from any location.
 
 C++:
 ```bash
 git clone https://github.com/cms-cat/cmsstyle.git
 cd cmsstyle
-source scripts/setup_cmstyle 
+source scripts/setup_cmstyle
 ```
 
+For the C++ to work from inside ROOT (and any location), it is recommended to
+add something like the following to the rootlogon.C macro (or equivalent):
+```if (gSystem->Getenv("CMSSTYLE_DIR")!=nullptr) {
+  std::string var = string(gROOT->GetMacroPath())+":"+gSystem->Getenv("CMSSTYLE_DIR")+"/src";
+  gROOT->SetMacroPath(var.c_str());
+  std::cout<<"Adding the ${CMSSTYLE_DIR}/src to the macro path"<<std::endl;
+}
+```
+In fact a similar configuration may be achieved by modifying the ``${HOME}/.rootrc`` instead.
+
+## Installation inside the CMSSW
+
+If you use a CMSSW that supports the _scram-venv_ you may use that to achieve
+the installation of the python package with pip already locally, as described
+in [this page](http://cms-sw.github.io/venv.html) using the following instructions:
+```scram-venv
+cmsenv
+
+pip install cmstyle
+```
+
+It should be remarked that after installation of the _venv_ (done by
+_scram-venv_) that step is no longer needed, but the working directory should
+be used always in the virtual enviroment (that should be already setup when
+doing the commonly required _cmsenv_ command.
+
+Remark that if you have a local installacion of cmsstyle, it may collide with
+the virtual environment, so you may want to do
+```export PYTHONNOUSERSITE=True
+```
+to prevent the conflicts.
+
+In the case of the C++ code, it is possible to add the code as source code but
+downloading the packages as mentioned above. Keep in mind that the repository
+does not follows the required structure for CMSSW packages, so you may
+encounter difficulties to integrate. _Do not hesitate to contact us for the use
+case_.
+
 ## Documentation
 
 Documentation for the Python implementation is available at [cmsstyle.readthedocs.io](https://cmsstyle.readthedocs.io/). C++ implementation is analogous.

scripts/check_integrity.sh

@@ -0,0 +1,64 @@
+#!/usr/bin/env bash
+#
+# This bash macro allows to perform some integrity checks, similar to the
+# workflows that are run at the GitHub server, but that can be run locally.
+#
+# Written by O. Gonzalez (2025_03_11)
+#
+
+# It should be run from the top of the package/release
+
+if [ ! -d src ] ; then
+    echo "ERROR: Run this scripts from the head of the local release"
+    exit 10
+fi
+#
+# First: We are running on a EL9 container some check given by the following
+# code:
+#
+cat <<EOF  > tmp$$_integrity_el9.sh
+echo
+echo "Starting check inside container!"
+stat -c %U /root
+pwd
+# Trying to compile the python version
+python3 -V
+\rm -rf src/cmsstyle/__pycache__ &> /dev/null
+python3 -m py_compile src/cmsstyle/cmsstyle.py
+ls -lh src/cmsstyle/__pycache__/
+\rm -rf src/cmsstyle/__pycache__ &> /dev/null
+
+# Trying to compile for ROOT
+echo 'ROOT VERSION='`root-config --version`
+cd src
+echo '{gROOT->LoadMacro("cmsstyle.C++");}' > /tmp/compiling.C
+root -q /tmp/compiling.C
+ls -lh cmsstyle_C.so
+\rm -rf cmsstyle_C* &> /dev/null
+cd ..
+echo
+EOF
+chmod a+x tmp$$_integrity_el9.sh
+
+# Running in a container
+apptainer exec -B /cvmfs /cvmfs/unpacked.cern.ch/registry.hub.docker.com/rootproject/root:6.32.00 ./tmp$$_integrity_el9.sh
+\rm -rf tmp$$_integrity_el9.sh &> /dev/null
+#
+# We also try to compile in python2.7:
+#
+cat <<EOF  > tmp$$_integrity_cc7.sh
+echo
+echo "Running in a CC7 container for python 2.7"
+python -V
+\rm -rf src/cmsstyle/cmsstyle.pyc &> /dev/null
+python -m py_compile src/cmsstyle/cmsstyle.py
+ls -lh src/cmsstyle/cmsstyle.pyc
+\rm -rf src/cmsstyle/cmsstyle.pyc &> /dev/null
+echo
+EOF
+chmod a+x tmp$$_integrity_cc7.sh
+# Running in a container
+apptainer exec -B /cvmfs /cvmfs/unpacked.cern.ch/gitlab-registry.cern.ch/cms-cloud/cmssw-docker/cc7-cms:latest ./tmp$$_integrity_cc7.sh
+
+\rm -rf tmp$$_integrity_cc7.sh &> /dev/null
+#