scisoftdev-tmp-HiPOP 1.0.9__tar.gz → 1.0.11__tar.gz

{scisoftdev_tmp_hipop-1.0.9 → scisoftdev_tmp_hipop-1.0.11}/.github/workflows/ci.yaml

@@ -7,6 +7,7 @@ on:
   pull_request:
     branches:
       - main
+  workflow_dispatch: # Manual trigger
 
 jobs:
   build-and-test:

{scisoftdev_tmp_hipop-1.0.9 → scisoftdev_tmp_hipop-1.0.11}/.github/workflows/deploy.yaml

@@ -4,7 +4,6 @@ on:
   push:
     tags:
       - 'v*.*.*' # Trigger on version tags like v1.2.3
-  # TODO define the trigger with EMobLab once the workflow is stable
 
 jobs:
 
@@ -88,7 +87,6 @@ jobs:
       - check-version
       - build-wheels
       - build-sdist
-    # TODO keep? if: github.event_name == 'release'
 
     environment:
       name: pypi-env

scisoftdev_tmp_hipop-1.0.11/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: scisoftdev-tmp-HiPOP
+Version: 1.0.11
+Summary: High Performance Optimal Path module
+Keywords: graph,graph-theory,shortest-path,dijkstra
+License-Expression: LGPL-3.0-only
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: Repository, https://github.com/EMob-Lab/HiPOP
+Project-URL: Issues, https://github.com/EMob-Lab/HiPOP/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# HiPOP
+
+High Performance Optimal Path module
+
+
+## Description
+
+HiPOP is the C++ graph library used by [MnMS](https://github.com/EMob-Lab/MnMS.git).
+It is composed of:
+- a C++ core library implementing a graph data-structure and several shortest path search algorithms,
+- a Python wrapper exposing the C++ classes and functions to the Python world.
+
+
+## Install HiPOP
+
+### Install prebuilt distribution
+
+This is the recommended (and most simple!) method to install HiPOP:
+a prebuilt distribution adapted to your Python version and OS / system architecture
+is downloaded from [PyPI](https://pypi.org/project/scisoftdev-tmp-HiPOP).
+
+```shell
+pip install scisoftdev-tmp-HiPOP # TODO change package name (and links in the whole page)
+```
+
+This installation method requires your OS / system architecture to be one of these:
+- Windows on x86_64 architecture (i.e. Intel/AMD CPU)
+- Linux on x86_64 architecture (i.e. Intel/AMD CPU)
+- MacOS (≥ 14 Sonoma) on ARM64 architecture (i.e. Apple M* CPU)
+
+The exact list of prebuilt distributions is available on
+https://pypi.org/project/scisoftdev-tmp-HiPOP/#files.
+If none of them matches your environment, please contact the package maintainers,
+or try the local build installation method.
+
+
+### Install from local build
+
+This method requires the following components to be available on your system:
+
+- C++ compiler that supports C++17 and [OpenMP](https://www.openmp.org/)
+- [CMake](https://cmake.org/)
+
+Then, here is the local build install procedure:
+
+1. Download the latest HiPOP sources from https://github.com/EMob-Lab/HiPOP/archive/refs/heads/main.zip
+   or by cloning the git repository:
+   ```shell
+   git clone https://github.com/EMob-Lab/HiPOP.git
+   ```
+
+2. From the root directory of the HiPOP sources:
+   ```shell
+   pip install .
+
+   # Optionally, to run the tests:
+   pip install --group dev
+   pytest
+   ```
+
+Remarks:
+
+- The `--group <group-name>` option requires pip ≥ 25.1. If you have an older version,
+  the install command above will fail with an error message such as `no such option: --group`.
+  In this case, try to upgrade pip beforehand with:
+  ```shell
+  pip install --upgrade pip
+  ```
+  Alternatively, install the test runner `pytest` manually (or skip the optional test running step).
+
+- Editable install mode can be used. The install command then becomes:
+  ```shell
+  pip install --group dev --editable .
+  ```
+  Please note that using the `--group dev` option (or equivalent, to install the dev dependencies)
+  is mandatory for HiPOP editable installs.
+
+- If you don't have the prerequisite C++/OpenMP/CMake components available on your system,
+  but you have [Conda](https://docs.conda.io/) available, a Conda environment with these components
+  is provided with the HiPOP sources. Install and activate it with:
+  ```shell
+  conda create -f conda/env.yaml
+  conda activate hipop-dev
+  ```
+  Please note that the use of this Conda environment is optional. HiPOP can be used with regular
+  (non-Conda) set-ups.
+
+- If you are using MacOS and the Apple Clang C++ compiler, please note that OpenMP
+  may not be available by default. You may install it with:
+  ```shell
+  brew install libomp
+  OpenMP_ROOT=$(brew --prefix libomp)
+  ```
+  Alternatively, you may also use the Conda environment provided with the HiPOP sources
+  (cf. previous remark).
+
+
+### Install the C++ core library only (from local build)
+
+This installation procedure allows you to build locally and install only the HiPOP C++ core library.
+The Python wrapper is neither built nor installed here.
+This procedure is intended for advanced users.
+
+For this procedure, same requirements as mentioned in the previous section
+in terms of C++/OpenMP/CMake components.
+However, you don't need to have Python installed on your system.
+
+Then, from the root directory of the HiPOP sources:
+```shell
+mkdir build
+cd build
+cmake .. -DCMAKE_INSTALL_PREFIX=<install-directory>
+make
+make test    # Optionally, to run the tests
+make install
+```
+... where `<install-directory>` is the path to the location where you want to install HiPOP.

scisoftdev_tmp_hipop-1.0.11/README.md

@@ -0,0 +1,117 @@
+# HiPOP
+
+High Performance Optimal Path module
+
+
+## Description
+
+HiPOP is the C++ graph library used by [MnMS](https://github.com/EMob-Lab/MnMS.git).
+It is composed of:
+- a C++ core library implementing a graph data-structure and several shortest path search algorithms,
+- a Python wrapper exposing the C++ classes and functions to the Python world.
+
+
+## Install HiPOP
+
+### Install prebuilt distribution
+
+This is the recommended (and most simple!) method to install HiPOP:
+a prebuilt distribution adapted to your Python version and OS / system architecture
+is downloaded from [PyPI](https://pypi.org/project/scisoftdev-tmp-HiPOP).
+
+```shell
+pip install scisoftdev-tmp-HiPOP # TODO change package name (and links in the whole page)
+```
+
+This installation method requires your OS / system architecture to be one of these:
+- Windows on x86_64 architecture (i.e. Intel/AMD CPU)
+- Linux on x86_64 architecture (i.e. Intel/AMD CPU)
+- MacOS (≥ 14 Sonoma) on ARM64 architecture (i.e. Apple M* CPU)
+
+The exact list of prebuilt distributions is available on
+https://pypi.org/project/scisoftdev-tmp-HiPOP/#files.
+If none of them matches your environment, please contact the package maintainers,
+or try the local build installation method.
+
+
+### Install from local build
+
+This method requires the following components to be available on your system:
+
+- C++ compiler that supports C++17 and [OpenMP](https://www.openmp.org/)
+- [CMake](https://cmake.org/)
+
+Then, here is the local build install procedure:
+
+1. Download the latest HiPOP sources from https://github.com/EMob-Lab/HiPOP/archive/refs/heads/main.zip
+   or by cloning the git repository:
+   ```shell
+   git clone https://github.com/EMob-Lab/HiPOP.git
+   ```
+
+2. From the root directory of the HiPOP sources:
+   ```shell
+   pip install .
+
+   # Optionally, to run the tests:
+   pip install --group dev
+   pytest
+   ```
+
+Remarks:
+
+- The `--group <group-name>` option requires pip ≥ 25.1. If you have an older version,
+  the install command above will fail with an error message such as `no such option: --group`.
+  In this case, try to upgrade pip beforehand with:
+  ```shell
+  pip install --upgrade pip
+  ```
+  Alternatively, install the test runner `pytest` manually (or skip the optional test running step).
+
+- Editable install mode can be used. The install command then becomes:
+  ```shell
+  pip install --group dev --editable .
+  ```
+  Please note that using the `--group dev` option (or equivalent, to install the dev dependencies)
+  is mandatory for HiPOP editable installs.
+
+- If you don't have the prerequisite C++/OpenMP/CMake components available on your system,
+  but you have [Conda](https://docs.conda.io/) available, a Conda environment with these components
+  is provided with the HiPOP sources. Install and activate it with:
+  ```shell
+  conda create -f conda/env.yaml
+  conda activate hipop-dev
+  ```
+  Please note that the use of this Conda environment is optional. HiPOP can be used with regular
+  (non-Conda) set-ups.
+
+- If you are using MacOS and the Apple Clang C++ compiler, please note that OpenMP
+  may not be available by default. You may install it with:
+  ```shell
+  brew install libomp
+  OpenMP_ROOT=$(brew --prefix libomp)
+  ```
+  Alternatively, you may also use the Conda environment provided with the HiPOP sources
+  (cf. previous remark).
+
+
+### Install the C++ core library only (from local build)
+
+This installation procedure allows you to build locally and install only the HiPOP C++ core library.
+The Python wrapper is neither built nor installed here.
+This procedure is intended for advanced users.
+
+For this procedure, same requirements as mentioned in the previous section
+in terms of C++/OpenMP/CMake components.
+However, you don't need to have Python installed on your system.
+
+Then, from the root directory of the HiPOP sources:
+```shell
+mkdir build
+cd build
+cmake .. -DCMAKE_INSTALL_PREFIX=<install-directory>
+make
+make test    # Optionally, to run the tests
+make install
+```
+... where `<install-directory>` is the path to the location where you want to install HiPOP.

scisoftdev_tmp_hipop-1.0.11/VERSION.txt

@@ -0,0 +1 @@
+1.0.11

{scisoftdev_tmp_hipop-1.0.9 → scisoftdev_tmp_hipop-1.0.11}/pyproject.toml

@@ -54,6 +54,10 @@ distrib = [ # Dependencies needed to build distribution files (wheels & source d
     "cibuildwheel >= 4.2",
 ]
 
+
+# ------------------------------------------------------------------------------
+# Configuration of the build
+
 [build-system]
 requires = [ # Must be kept identical to "dependency-groups".build
     "dynamic-metadata >= 0.5",
@@ -86,8 +90,12 @@ HIPOP_WITH_EXAMPLES = "OFF"
 path = "hipop/__init__.py"
 template-path = "python/hipop/__init__.py.template"
 
+
+# ------------------------------------------------------------------------------
+# Configuration of distribution file generation wheels & source distributions)
+
 [tool.cibuildwheel]
-build = [ # Build Linux + Win for x64, and MacOS for ARM64. TODO is it enough?
+build = [
     "*-manylinux_x86_64",
     "*-win_amd64",
     "*-macosx_arm64",

scisoftdev_tmp_hipop-1.0.9/PKG-INFO

@@ -1,81 +0,0 @@
-Metadata-Version: 2.4
-Name: scisoftdev-tmp-HiPOP
-Version: 1.0.9
-Summary: High Performance Optimal Path module
-Keywords: graph,graph-theory,shortest-path,dijkstra
-License-Expression: LGPL-3.0-only
-License-File: LICENSE
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Operating System :: MacOS
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: C++
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Project-URL: Repository, https://github.com/EMob-Lab/HiPOP
-Project-URL: Issues, https://github.com/EMob-Lab/HiPOP/issues
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-
-# HiPOP
-High Performance Optimal Path module
-
-## Install Hipop
-
-HiPOP is the C++ graph library used by [MnMS](https://github.com/EMob-Lab/MnMS.git). 
-You must have `CMake` and `make` installed on your computer.
-
-## WARNING
-If you are using MacOS ARM64, install the openmp library using Homebrew:
-```shell
-brew install libomp
-```
-
-### C++ only
-
-Inside your conda environment go to the cpp folder, and install the code using cmake:
-
-```shell
-cd cpp
-mkdir build
-cd build
-cmake .. -DCMAKE_PREFIX_PATH=<PREFIX>\
-         -DCMAKE_INSTALL_PREFIX=<PREFIX>\
-         -DCMAKE_BUILD_TYPE=Release\
-         -DBUILD_TESTS=ON
-cmake --build . --target install --config Release
-```
-Where `<PREFIX>` is the path to your prefix.
-
-If you used conda to install the dependencies, replace it by `$CONDA_PREFIX`.
-
-If you used venv to install the dependencies, replace it by the path to your venv.
-
-You can then lauch the tests in the `build` directory:
-
-```shell
-ctest --output-on-failure
-```
-
-
-### Python
-
-To install C++ code use the script `install_cpp.py`:
-
-```shell
-python python/install_cpp.py   
-```
-
-Then install the python lib:
-```shell
-python -m pip install python/
-```

scisoftdev_tmp_hipop-1.0.9/README.md

@@ -1,53 +0,0 @@
-# HiPOP
-High Performance Optimal Path module
-
-## Install Hipop
-
-HiPOP is the C++ graph library used by [MnMS](https://github.com/EMob-Lab/MnMS.git). 
-You must have `CMake` and `make` installed on your computer.
-
-## WARNING
-If you are using MacOS ARM64, install the openmp library using Homebrew:
-```shell
-brew install libomp
-```
-
-### C++ only
-
-Inside your conda environment go to the cpp folder, and install the code using cmake:
-
-```shell
-cd cpp
-mkdir build
-cd build
-cmake .. -DCMAKE_PREFIX_PATH=<PREFIX>\
-         -DCMAKE_INSTALL_PREFIX=<PREFIX>\
-         -DCMAKE_BUILD_TYPE=Release\
-         -DBUILD_TESTS=ON
-cmake --build . --target install --config Release
-```
-Where `<PREFIX>` is the path to your prefix.
-
-If you used conda to install the dependencies, replace it by `$CONDA_PREFIX`.
-
-If you used venv to install the dependencies, replace it by the path to your venv.
-
-You can then lauch the tests in the `build` directory:
-
-```shell
-ctest --output-on-failure
-```
-
-
-### Python
-
-To install C++ code use the script `install_cpp.py`:
-
-```shell
-python python/install_cpp.py   
-```
-
-Then install the python lib:
-```shell
-python -m pip install python/
-```

scisoftdev_tmp_hipop-1.0.9/VERSION.txt

@@ -1 +0,0 @@
-1.0.9