-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Improving performance of bytes plugin and of capnp transfers over XDR/RPC - Adding fixes for fatclient pyuda build - adding support for python3.13 wheels in linux and macos (not windows) - fixing timestamp microseconds error in uda logging - updating plugin::version() function convention to return the server semantic version number so server version can be queried from remote clients. - updates to documentation and adding a contributing.md - fixing some UKAEA issues with the IDL wrapper --------- Co-authored-by: Adam Parker <[email protected]> Co-authored-by: Jonathan Hollocombe <[email protected]> Co-authored-by: Maarten Sebregts <[email protected]> Co-authored-by: Olivier Hoenen <[email protected]> Co-authored-by: Adam Parker <[email protected]>
- Loading branch information
6 people
authored
Jan 23, 2025
1 parent
cb503c0
commit 8515a1a
Showing
56 changed files
with
1,149 additions
and
606 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,15 +18,15 @@ jobs: | |
| build: | ||
| strategy: | ||
| matrix: | ||
| os: [ubuntu-latest, windows-latest, macos-latest] | ||
| os: [ubuntu-22.04, windows-latest, macos-latest] | ||
| release: [Release] | ||
| ssl: [ON, OFF] | ||
| client-only: [ON, OFF] | ||
| capnp: [ON, OFF] | ||
| exclude: | ||
| - os: windows-latest | ||
| client-only: OFF | ||
| - os: ubuntu-latest | ||
| - os: ubuntu-22.04 | ||
| client-only: ON | ||
| - os: macos-latest | ||
| client-only: ON | ||
|
|
@@ -38,7 +38,7 @@ jobs: | |
| shell: bash | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/github-script@v7 | ||
| with: | ||
|
|
@@ -47,7 +47,7 @@ jobs: | |
| core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || ''); | ||
| - name: Install linux dependencies | ||
| if: matrix.os == 'ubuntu-latest' | ||
| if: matrix.os == 'ubuntu-22.04' | ||
| run: > | ||
| sudo apt update && sudo apt install -y | ||
| git | ||
|
|
@@ -67,7 +67,7 @@ jobs: | |
| python3-venv | ||
| - name: Install Intel compiler | ||
| if: matrix.os == 'ubuntu-latest' | ||
| if: matrix.os == 'ubuntu-22.04' | ||
| run: > | ||
| sudo apt install -y wget && | ||
| wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB && | ||
|
|
@@ -115,7 +115,7 @@ jobs: | |
| spdlog | ||
| - name: Configure CMake (linux) | ||
| if: matrix.os == 'ubuntu-latest' | ||
| if: matrix.os == 'ubuntu-22.04' | ||
| run: > | ||
| cmake -G Ninja -B build | ||
| -DBUILD_SHARED_LIBS=ON | ||
|
|
@@ -125,7 +125,7 @@ jobs: | |
| -DENABLE_CAPNP=${{ matrix.capnp }} | ||
| - name: Configure CMake (linux Intel) | ||
| if: matrix.os == 'ubuntu-latest' | ||
| if: matrix.os == 'ubuntu-22.04' | ||
| run: > | ||
| source /opt/intel/oneapi/setvars.sh && | ||
| CXX=icpx CC=icx cmake -G Ninja -B build-intel | ||
|
|
@@ -176,7 +176,7 @@ jobs: | |
| run: cmake --build build --config ${{ matrix.release }} | ||
|
|
||
| - name: Build Intel | ||
| if: matrix.os == 'ubuntu-latest' | ||
| if: matrix.os == 'ubuntu-22.04' | ||
| run: cmake --build build-intel --config ${{ matrix.release }} | ||
|
|
||
| - name: Install | ||
|
|
@@ -188,7 +188,7 @@ jobs: | |
| run: cmake --install build --config ${{ matrix.release }} | ||
|
|
||
| - name: Install pyuda | ||
| if: matrix.os == 'ubuntu-latest' | ||
| if: matrix.os == 'ubuntu-22.04' | ||
| run: > | ||
| cp -r /usr/local/python_installer ${{github.workspace}}/python_installer && | ||
| python3 -m venv ${{github.workspace}}/venv && | ||
|
|
@@ -198,13 +198,13 @@ jobs: | |
| pip3 install ${{github.workspace}}/python_installer | ||
| - name: Test pyuda import | ||
| if: matrix.os == 'ubuntu-latest' | ||
| if: matrix.os == 'ubuntu-22.04' | ||
| run: > | ||
| source ${{github.workspace}}/venv/bin/activate && | ||
| python3 -c 'import pyuda; client=pyuda.Client()' | ||
| - name: Run non-SSL system tests | ||
| if: matrix.os == 'ubuntu-latest' && matrix.ssl == 'OFF' | ||
| if: matrix.os == 'ubuntu-22.04' && matrix.ssl == 'OFF' | ||
| run: > | ||
| sudo cp /usr/local/etc/uda.socket /usr/local/etc/[email protected] /etc/systemd/system && | ||
| sudo systemctl start uda.socket && | ||
|
|
@@ -216,7 +216,7 @@ jobs: | |
| ./build/test/plugins/plugin_test_testplugin | ||
| - name: Run SSL system tests | ||
| if: matrix.os == 'ubuntu-latest' && matrix.ssl == 'ON' | ||
| if: matrix.os == 'ubuntu-22.04' && matrix.ssl == 'ON' | ||
| run: > | ||
| sudo cp /usr/local/etc/uda.socket /usr/local/etc/[email protected] /etc/systemd/system && | ||
| sudo chown -R $USER:$USER /usr/local/etc && | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # Contributing to UDA | ||
|
|
||
| UDA is an open-source project and we welcome contributions. This guide explains the process and expectations for getting your changes added. | ||
|
|
||
| --- | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| 1. [Getting Started](#getting-started) | ||
| - [Fork the Repository](#fork-the-repository) | ||
| - [Create an Issue](#create-an-issue) | ||
| - [Set Up Your Local Environment](#set-up-your-local-environment) | ||
| 2. [Branching Strategy](#branching-strategy) | ||
| 3. [Making Changes](#making-changes) | ||
| 4. [Submitting Your Contribution](#submitting-your-contribution) | ||
| 5. [Review Process](#review-process) | ||
|
|
||
| --- | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### 1. Fork the Repository | ||
| 1. Navigate to the [uda repository](https://github.com/ukaea/uda). | ||
| 2. Click the **Fork** button in the top-right corner to create a copy of the repository under your GitHub account. | ||
|
|
||
| ### 2. Create an Issue | ||
| Before starting work, please open an issue to describe your contribution. This helps us track ongoing efforts. | ||
|
|
||
| 1. Go to the [Issues tab](https://github.com/ukaea/uda/issues). | ||
| 2. Create a new issue with a clear description of the bug, feature, or improvement you want to work on. | ||
| 3. Wait for a project maintainer to approve or provide feedback. | ||
|
|
||
| ### 3. Set Up Your Local Environment | ||
| See the [development guide](https://ukaea.github.io/UDA/development/) in the UDA documentation pages for more detialed instructions on getting started. | ||
|
|
||
| --- | ||
|
|
||
| ## Branching Strategy | ||
|
|
||
| We use the **GitFlow branching model**. Here's how branches are structured: | ||
|
|
||
| - **`main`**: Contains stable, production-ready code. Do not merge changes directly into `main`. | ||
| - **`develop`**: The active development branch. Your contributions should be merged into `develop`. | ||
| - **Feature branches**: Used for individual features. Create a feature branch off `develop`: | ||
| ```bash | ||
| git checkout -b feature/your-feature-name develop | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Making Changes | ||
|
|
||
| 1. Pull the latest changes from the `develop` branch to ensure your branch is up to date: | ||
| ```bash | ||
| git checkout develop | ||
| git pull upstream develop | ||
| ``` | ||
| 2. Create a new feature branch for your work: | ||
| ```bash | ||
| git checkout -b feature/your-feature-name develop | ||
| ``` | ||
| 3. Make your changes and commit them with clear, descriptive commit messages: | ||
| ```bash | ||
| git add . | ||
| git commit -m "Add feature X to improve Y" | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Submitting Your Contribution | ||
|
|
||
| 1. Push your changes to your fork: | ||
| ```bash | ||
| git push origin feature/your-feature-name | ||
| ``` | ||
| 2. Open a pull request (PR) from your feature branch to the `develop` branch in the original repository: | ||
| - Navigate to your fork on GitHub. | ||
| - Click the **Compare & Pull Request** button. | ||
| - Select the `develop` branch of the original repository as the base branch. | ||
| 3. Provide a clear title and description for your PR. Reference the issue you are addressing. | ||
|
|
||
| --- | ||
|
|
||
| ## Review Process | ||
|
|
||
| 1. Once your PR is submitted, a maintainer will review it. | ||
| 2. Be prepared to make changes based on feedback. | ||
| 3. When your PR is approved, a maintainer will merge it into the `develop` branch. | ||
|
|
||
| --- | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.