{"id":19865602,"url":"https://github.com/ct-clmsn/nofi","last_synced_at":"2025-06-22T12:04:36.503Z","repository":{"id":76760463,"uuid":"464006927","full_name":"ct-clmsn/nofi","owner":"ct-clmsn","description":"Nim wrapper of ROFI (Rust Open Fabrics Interface)","archived":false,"fork":false,"pushed_at":"2022-03-10T02:11:27.000Z","size":41,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-23T18:37:29.259Z","etag":null,"topics":["distributed-computing","high-performance-computing","hpc","libfabric","nim","supercomputing"],"latest_commit_sha":null,"homepage":"","language":"Nim","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ct-clmsn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-27T01:15:38.000Z","updated_at":"2023-04-21T06:37:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"9ed9012e-38b4-4971-b190-4701d8d6de21","html_url":"https://github.com/ct-clmsn/nofi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ct-clmsn%2Fnofi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ct-clmsn%2Fnofi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ct-clmsn%2Fnofi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ct-clmsn%2Fnofi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ct-clmsn","download_url":"https://codeload.github.com/ct-clmsn/nofi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065281,"owners_count":21041872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["distributed-computing","high-performance-computing","hpc","libfabric","nim","supercomputing"],"created_at":"2024-11-12T15:23:21.895Z","updated_at":"2025-04-09T16:20:43.384Z","avatar_url":"https://github.com/ct-clmsn.png","language":"Nim","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Copyright (c) 2022 Christopher Taylor                                          --\u003e\n\u003c!--                                                                                --\u003e\n\u003c!--   Distributed under the Boost Software License, Version 1.0. (See accompanying --\u003e\n\u003c!--   file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)        --\u003e\n# [nofi - Nim OpenFabrics Interface](https://github.com/ct-clmsn/nofi)\n\nNofi wraps the existing [rofi](https://github.com/pnnl/rofi) interface implemented by Pacific Northwest National\nLaboratory (PNNL). Nofi provides the Nim programming language support\nfor RDMA distributed communication (put and get), fundamental operations\nfor [PGAS](https://en.wikipedia.org/wiki/Partitioned_global_address_space) applications.\n\nThis library extends rofi by providing a [sequence type](https://nim-lang.org/docs/system.html#seq) that wraps memory\nregistered with the underlying rofi RDMA communicaton library. The sequence type\nonly supports values that are of [SomeNumber](https://nim-lang.org/docs/system.html#SomeNumber) types. The sequence\ntype provides element-access, slice, iterator, and partitioning support.\n\nAdditional functionality is provided to handle asynchronous `put` and `get` operations using Nim's [defer statements](https://nim-lang.org/docs/manual.html#exception-handling-defer-statement), combining [templates](https://nim-lang.org/docs/manual.html#templates) with [try statements](https://nim-lang.org/docs/manual.html#exception-handling-try-expression), and [futures](https://nim-lang.org/docs/asyncfutures.html).\n\n**Nim applications using nofi require static compilation and linking!**\n\n### Install\n\nDownload and install [rofi](https://github.com/pnnl/rofi)\n```\n./configure --prefix=\u003cPATH_TO_INSTALL_DIR\u003e\nmake \u0026\u0026 make install\nexport LD_LIBRARY_PATH=\u003cPATH_TO_INSTALL_DIR\u003e/lib:$LD_LIBRARY_PATH\n```\n\nModify `makefile` to point `LIBDIR` and `INCDIR` to the\npath set in `\u003cPATH_TO_INSTALL_DIR\u003e`. Use the makefile to\nsee if your setup compiles.\n```\nmake\n```\n\nUse the nimble tool to install nofi\n```\nnimble install nofi\n```\n\nGenerate documentation from source\n```\nnimble doc nofi\n```\n\n### Important Developer Notes\n\nNofi demonstrates the versitility of the [rofi library](https://github.com/pnnl/rofi) and\nit's value as a lightweight technology for extending RDMA\nsupport via libfabric to languages that have a FFI (foreign\nfunction interface) compatible with C.\n\nUsers need to review the [rofi documentation](https://github.com/pnnl/rofi/blob/master/README.md) prior\nto using this library in order to understand rofi's feature\nset and potential limitations.\n\nThis library requires static compilation of an end user's\nNim program. Please review the `makefile` to learn how to\nenable static compilation and linking with the Nim compiler.\n\nUsers must initialize and terminate all programs using\n`nofi_init` and `nofi_finit`. Not taking this step will\nresult in undefined behavior.\n\nUsers are strongly encouraged to utilize Nim blocks and\nscoping rules to managing memory that has been registered\nwith nofi. Users can review 'tests/test_sharray.nim' for\nan example of memory management using Nim blocks and scopes.\n\n### Examples\n\nThe directory 'tests/' provides several examples regarding\nhow to interact with this library.\n\n### Licenses\n\n* nofi is Boost Version 1.0 (2022-)\n* rofi is BSD License (2020)\n\n### Date\n\n24 February 2022\n\n### Author\n\nChristopher Taylor\n\n### Special Thanks to the ROFI authors\n\n* Roberto Gioiosa - roberto.gioiosa@pnnl.gov\n* Ryan Friese - ryan.friese@pnnl.gov\n* Mark Raugas - mark.raugas@pnnl.gov\n* Pacific Northwest National Labs/US Department of Energy\n\n### Many Thanks\n\n* The Nim community and user/developer forum\n\n### Dependencies\n\n* [nim 1.6.4](https://nim-lang.org)\n* [libfabric](https://github.com/ofiwg/libfabric)\n* [Rust OpenFabrics Interface Transport Layer - rofi](https://github.com/pnnl/rofi)\n\n### rofi Dependencies\n\n* [GNU Autotools](https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html)\n* [libfabric](https://github.com/ofiwg/libfabric)\n* [libibverbs](https://github.com/linux-rdma/rdma-core/tree/master/libibverbs)\n* [uthash](https://github.com/troydhanson/uthash)\n* [libatomic](https://github.com/gcc-mirror/gcc/tree/master/libatomic)\n* librt: Extended realtime library, generally installed on Linux development clusters\n* pthreads: POSIX thread library, generally installed on Linux development clusters\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fct-clmsn%2Fnofi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fct-clmsn%2Fnofi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fct-clmsn%2Fnofi/lists"}