{"id":26501878,"url":"https://github.com/upscayl/upscayl-ncnn","last_synced_at":"2025-03-20T17:03:36.704Z","repository":{"id":199276575,"uuid":"678412424","full_name":"upscayl/upscayl-ncnn","owner":"upscayl","description":"The Upscayl backend powered by the NCNN framework and Real-ESRGAN architecture.","archived":false,"fork":true,"pushed_at":"2024-08-01T19:15:54.000Z","size":1671,"stargazers_count":130,"open_issues_count":1,"forks_count":25,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-01T21:43:25.930Z","etag":null,"topics":["esrgan","ncnn","real-esrgan","real-esrgan-gui","upscale","upscayl"],"latest_commit_sha":null,"homepage":"https://upscayl.org","language":"C","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"xinntao/Real-ESRGAN-ncnn-vulkan","license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/upscayl.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}},"created_at":"2023-08-14T13:47:28.000Z","updated_at":"2024-08-01T19:15:59.000Z","dependencies_parsed_at":"2023-10-11T23:10:49.842Z","dependency_job_id":null,"html_url":"https://github.com/upscayl/upscayl-ncnn","commit_stats":null,"previous_names":["upscayl/ncnn"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/upscayl%2Fupscayl-ncnn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/upscayl%2Fupscayl-ncnn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/upscayl%2Fupscayl-ncnn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/upscayl%2Fupscayl-ncnn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/upscayl","download_url":"https://codeload.github.com/upscayl/upscayl-ncnn/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244656704,"owners_count":20488638,"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":["esrgan","ncnn","real-esrgan","real-esrgan-gui","upscale","upscayl"],"created_at":"2025-03-20T17:01:57.515Z","updated_at":"2025-03-20T17:03:36.695Z","avatar_url":"https://github.com/upscayl.png","language":"C","funding_links":[],"categories":["C"],"sub_categories":[],"readme":"# Installation:\n\n### Prerequisites:\n\n- `cmake`\n- `gcc-9` and `g++-9`\n- `Vulkan SDK`\n  - Download the latest Vulkan SDK tarball from [https://vulkan.lunarg.com/sdk/home](https://vulkan.lunarg.com/sdk/home) and extract it using:\\\n     `wget https://sdk.lunarg.com/sdk/download/1.3.280.1/linux/vulkansdk-linux-x86_64-1.3.280.1.tar.xz \u0026\u0026 tar -xf vulkansdk-linux-x86_64-1.3.280.1.tar.xz \u0026\u0026 rm vulkansdk-linux-x86_64-1.3.280.1.tar.xz`\n\n### Steps:\n\n1. Clone the repository with all submodules (requires an SSH key be added to your account):\n\n   `git clone --recursive git@github.com:upscayl/upscayl-ncnn.git`\n\n   `cd upscayl-ncnn` or if you've already cloned: `git submodule update --init --recursive`\n\n2. Set up environment variables: `export CC=\"gcc-9\" CXX=\"g++-9\" `\n3. `export VULKAN_SDK=/path` where you extracted your vulkan SDK -\u003e 1.3.280.1/x86_64\n4. Make a new build directory and cd into it: `mkdir build \u0026\u0026 cd build`\n5. Now, build : `cmake ../src`\n6. `cmake --build . -j 2` Replace the `-j 2` with the number of cores you want to use to compile\n\n## MacOS\n\n### Prerequisites:\n\n- openmp installed, install with `brew install libomp`\n- cmake installed, install with `brew install cmake`\n- Install VulkanSDK from the website and it should be in /Users/youruser/VulkanSDK/`\u003cversion\u003e` normally if you did not change anything\n\n### Steps:\n\nAfter making the build directory, open it and use the following cmake command (replace the paths from your system)\n\n```bash\nmkdir build-x86_64 \u0026\u0026 cd build-x86_64\ncmake -D USE_STATIC_MOLTENVK=ON -D CMAKE_OSX_ARCHITECTURES=\"x86_64\" -D OpenMP_C_FLAGS=\"-Xclang -fopenmp\" -D OpenMP_CXX_FLAGS=\"-Xclang -fopenmp\" -D OpenMP_C_LIB_NAMES=\"libomp\" -D OpenMP_CXX_LIB_NAMES=\"libomp\" -D OpenMP_libomp_LIBRARY=\"/opt/homebrew/opt/libomp/lib/libomp.a\" -D Vulkan_INCLUDE_DIR=\"./VulkanSDK/*/MoltenVK/include\" -D Vulkan_LIBRARY=./VulkanSDK/*/MoltenVK/MoltenVK.xcframework/macos-arm64_x86_64/libMoltenVK.a ../src\ncmake --build . -j 8\n```\n\nFor arm processors, the build command will only change to\n\n```bash\nmkdir build-arm64 \u0026\u0026 cd build-arm64\ncmake -D USE_STATIC_MOLTENVK=ON -D CMAKE_OSX_ARCHITECTURES=\"arm64\" -D CMAKE_CROSSCOMPILING=ON -D CMAKE_SYSTEM_PROCESSOR=arm64 -D OpenMP_C_FLAGS=\"-Xclang -fopenmp\" -D OpenMP_CXX_FLAGS=\"-Xclang -fopenmp -I/opt/homebrew/opt/libomp/include\" -D OpenMP_C_LIB_NAMES=\"libomp\" -D OpenMP_CXX_LIB_NAMES=\"libomp\" -D OpenMP_libomp_LIBRARY=\"/opt/homebrew/opt/libomp/lib/libomp.a\" -D Vulkan_INCLUDE_DIR=\"../VulkanSDK/1.3.261.1/MoltenVK/include\" -D Vulkan_LIBRARY=\"../VulkanSDK/1.3.261.1/MoltenVK/MoltenVK.xcframework/macos-arm64_x86_64/libMoltenVK.a\" ../src\ncmake --build . -j 8\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fupscayl%2Fupscayl-ncnn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fupscayl%2Fupscayl-ncnn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fupscayl%2Fupscayl-ncnn/lists"}