v1.1.0

.gitattributes

@@ -0,0 +1,6 @@
+.github/workflows export-ignore
+docs/assets export-ignore
+docs/scripts export-ignore
+ext export-ignore
+Doxyfile export-ignore
+.* export-ignore

.github/workflows/c-cpp.yml

@@ -0,0 +1,198 @@
+name: C/C++ CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Clone ParticleZoo repository
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+
+    - name: Install ROOT framework
+      run: sudo snap install root-framework
+
+    - name: Build and install ParticleZoo library without ROOT support
+      run: |
+        ./configure --no-root
+        make
+        sudo make install
+
+    - name: Verify installation
+      run: |
+        PHSPImage --version
+        PHSPCombine --version
+        PHSPConvert --version
+        PHSPSplit --version
+        PHSPConvert -f
+
+    - name: Build and install ParticleZoo library with ROOT support
+      run: |
+        sudo make uninstall
+        make clean
+        ./configure
+        make
+        sudo make install
+
+    - name: Verify installation
+      run: |
+        PHSPImage --version
+        PHSPCombine --version
+        PHSPConvert --version
+        PHSPSplit --version
+        PHSPConvert -f
+
+    - name: Install Python bindings
+      run: |
+        python -m venv .venv
+        source .venv/bin/activate
+        make install-python
+
+    - name: Run Python bindings smoke test
+      run: |
+        source .venv/bin/activate
+        cd examples/python
+        python write_phase_space.py test.egsphsp
+        python read_phase_space.py test.egsphsp
+
+  build-macos:
+    runs-on: macos-latest
+
+    steps:
+    - name: Clone ParticleZoo repository
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+
+    - name: Install ROOT framework
+      run: brew install root
+
+    - name: Build and install ParticleZoo library without ROOT support
+      run: |
+        ./configure --no-root
+        make
+        sudo make install
+
+    - name: Verify installation
+      run: |
+        PHSPImage --version
+        PHSPCombine --version
+        PHSPConvert --version
+        PHSPSplit --version
+        PHSPConvert -f
+
+    - name: Build and install ParticleZoo library with ROOT support
+      run: |
+        sudo make uninstall
+        make clean
+        ./configure
+        make
+        sudo make install
+
+    - name: Verify installation
+      run: |
+        PHSPImage --version
+        PHSPCombine --version
+        PHSPConvert --version
+        PHSPSplit --version
+        PHSPConvert -f
+
+    - name: Install Python bindings
+      run: |
+        python -m venv .venv
+        source .venv/bin/activate
+        make install-python
+
+    - name: Run Python bindings smoke test
+      run: |
+        source .venv/bin/activate
+        cd examples/python
+        python write_phase_space.py test.egsphsp
+        python read_phase_space.py test.egsphsp
+
+  build-windows:
+    runs-on: windows-latest
+
+    steps:
+    - name: Clone ParticleZoo repository
+      uses: actions/checkout@v4
+
+    - name: Setup MSVC
+      uses: ilammy/msvc-dev-cmd@v1
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+
+    - name: Cache ROOT framework
+      id: cache-root
+      uses: actions/cache@v4
+      with:
+        path: C:\root
+        key: root-v6.36.04-win64-python311-vc17
+
+    - name: Download and install ROOT framework
+      if: steps.cache-root.outputs.cache-hit != 'true'
+      run: |
+        echo "Downloading and installing ROOT framework..."
+        curl -sL -o root.zip https://root.cern/download/root_v6.36.04.win64.python311.vc17.zip
+        echo "Extracting ROOT framework..."
+        Expand-Archive -Path root.zip -DestinationPath C:\
+      shell: pwsh
+
+    - name: Add ROOT to PATH
+      run: echo "C:\root\bin" >> $env:GITHUB_PATH
+      shell: pwsh
+
+    - name: Build and install ParticleZoo library without ROOT support
+      run: |
+        .\build.bat install --no-root
+        echo "$env:LOCALAPPDATA\particlezoo\bin" >> $env:GITHUB_PATH
+
+    - name: Verify installation
+      run: |
+        PHSPImage --version
+        PHSPCombine --version
+        PHSPConvert --version
+        PHSPSplit --version
+        PHSPConvert -f
+
+    - name: Build and install ParticleZoo library with ROOT support
+      run: |
+        .\build.bat install
+        echo "$env:LOCALAPPDATA\particlezoo\bin" >> $env:GITHUB_PATH
+
+    - name: Verify installation
+      run: |
+        PHSPImage --version
+        PHSPCombine --version
+        PHSPConvert --version
+        PHSPSplit --version
+        PHSPConvert -f
+
+    - name: Install Python bindings
+      run: |
+        python -m venv .venv
+        .venv\Scripts\Activate.ps1
+        python -m pip install python/
+      shell: pwsh
+
+    - name: Run Python bindings smoke test
+      run: |
+        .venv\Scripts\Activate.ps1
+        cd examples/python
+        python write_phase_space.py test.egsphsp
+        python read_phase_space.py test.egsphsp
+      shell: pwsh

.gitignore

@@ -2,5 +2,24 @@ config.status
 build
 tests
 .vscode
+.venv
 docs/latex
-docs/html
+docs/html
+python/build/
+python/dist/
+python/**/*.egg-info/
+python/**/__pycache__/
+python/**/*.pyc
+python/**/*.pyo
+python/**/*.so
+python/**/*.dylib
+python/**/*.dll
+python/.eggs/
+python/*.egg
+python/.pytest_cache/
+python/.coverage
+python/htmlcov/
+python/.tox/
+python/.venv/
+python/venv/
+python/ENV/

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = "ParticleZoo"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v1.0.0
+PROJECT_NUMBER         = v1.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -2027,7 +2027,7 @@ LATEX_HEADER           = docs/scripts/header.tex
 # doing!
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_FOOTER           = 
+LATEX_FOOTER           = docs/scripts/footer.tex
 
 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
 # LaTeX style sheets that are included after the standard style sheets created
@@ -2046,7 +2046,7 @@ LATEX_EXTRA_STYLESHEET = docs/scripts/custom_doxygen.sty
 # markers available.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_EXTRA_FILES      = docs/assets/particlezoo.png
+LATEX_EXTRA_FILES      = docs/assets/particlezoo.png docs/scripts/python_appendix.tex
 
 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will

PHSPCombine.cc

@@ -73,14 +73,13 @@ int main(int argc, char* argv[]) {
     using namespace ParticleZoo;
     int errorCode = 0;
     uint64_t particlesSoFar = 0;
-    bool preserveConstants = false;
 
     // Custom command line arguments
-    const CLICommand MAX_PARTICLES_COMMAND = CLICommand(NONE, "", "maxParticles", "Maximum number of particles to process (default: unlimited)", { CLI_INT });
+    const CLICommand MAX_PARTICLES_COMMAND = CLICommand(NONE, "", "maxParticles", "Maximum number of particles to process (default: unlimited)", { CLI_UINT });
     const CLICommand INPUT_FORMAT_COMMAND = CLICommand(NONE, "", "inputFormat", "Force input file format (default: auto-detect from extension)", { CLI_STRING });
     const CLICommand OUTPUT_FORMAT_COMMAND = CLICommand(NONE, "", "outputFormat", "Force output file format (default: auto-detect from extension)", { CLI_STRING });
     const CLICommand OUTPUT_FILE_COMMAND = CLICommand(NONE, "", "outputFile", "Output file path", { CLI_STRING });
-    const CLICommand PRESERVE_CONSTANTS_COMMAND = CLICommand(NONE, "", "preserveConstants", "Preserve constant values from input files if present", { CLI_VALUELESS });
+    const CLICommand PRESERVE_CONSTANTS_COMMAND = CLICommand(NONE, "", "preserveConstants", "Preserve constant values from input files if present", { CLI_BOOL }, { true });
     ArgParser::RegisterCommand(MAX_PARTICLES_COMMAND);
     ArgParser::RegisterCommand(INPUT_FORMAT_COMMAND);
     ArgParser::RegisterCommand(OUTPUT_FORMAT_COMMAND);
@@ -104,20 +103,18 @@ int main(int argc, char* argv[]) {
     auto userOptions = ArgParser::ParseArgs(argc, argv, usageMessage, 1);
 
     // Validate parameters
-    std::uint64_t maxParticles = userOptions.contains(MAX_PARTICLES_COMMAND) ? std::get<int>(userOptions.at(MAX_PARTICLES_COMMAND)[0]) : std::numeric_limits<uint64_t>::max();
+    std::uint64_t maxParticles = userOptions.contains(MAX_PARTICLES_COMMAND) ? (std::uint64_t)userOptions.extractUIntOption(MAX_PARTICLES_COMMAND) : std::numeric_limits<uint64_t>::max();
     std::string inputFormat = userOptions.contains(INPUT_FORMAT_COMMAND) ? (userOptions.at(INPUT_FORMAT_COMMAND).empty() ? "" : std::get<std::string>(userOptions.at(INPUT_FORMAT_COMMAND)[0])) : "";
     std::string outputFormat = userOptions.contains(OUTPUT_FORMAT_COMMAND) ? (userOptions.at(OUTPUT_FORMAT_COMMAND).empty() ? "" : std::get<std::string>(userOptions.at(OUTPUT_FORMAT_COMMAND)[0])) : "";
     std::string outputFile = userOptions.contains(OUTPUT_FILE_COMMAND) ? (userOptions.at(OUTPUT_FILE_COMMAND).empty() ? "" : std::get<std::string>(userOptions.at(OUTPUT_FILE_COMMAND)[0])) : "";
     std::vector<CLIValue> positionals = userOptions.contains(CLI_POSITIONALS) ? userOptions.at(CLI_POSITIONALS) : std::vector<CLIValue>{};
+    bool preserveConstants = userOptions.contains(PRESERVE_CONSTANTS_COMMAND) ? std::get<bool>(userOptions.at(PRESERVE_CONSTANTS_COMMAND)[0]) : false;
     std::vector<std::string> inputFiles(positionals.size());
     for (size_t i = 0; i < positionals.size(); i++) {
         inputFiles[i] = std::get<std::string>(positionals[i]);
     }
     if (inputFiles.empty()) throw std::runtime_error("No input files provided.");
     if (outputFile == "") throw std::runtime_error("No output file specified.");
-    if (userOptions.contains(PRESERVE_CONSTANTS_COMMAND)) {
-        preserveConstants = true;
-    }
 
     FixedValues fixedValues; // start with default fixed values
     if (preserveConstants) {