{"id":24862002,"url":"https://github.com/hpcflow/install-scripts","last_synced_at":"2025-03-26T17:16:10.680Z","repository":{"id":94086515,"uuid":"577831918","full_name":"hpcflow/install-scripts","owner":"hpcflow","description":"Scripts to install pyinstaller folder version on a local machine.","archived":false,"fork":false,"pushed_at":"2024-02-13T15:11:57.000Z","size":191,"stargazers_count":0,"open_issues_count":18,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-31T22:24:44.929Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hpcflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-12-13T16:17:16.000Z","updated_at":"2023-04-13T15:16:29.000Z","dependencies_parsed_at":"2024-01-18T10:45:54.079Z","dependency_job_id":"942e77bc-0c7a-4eed-9f44-036cf5c5d7ac","html_url":"https://github.com/hpcflow/install-scripts","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/hpcflow%2Finstall-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hpcflow%2Finstall-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hpcflow%2Finstall-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hpcflow%2Finstall-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hpcflow","download_url":"https://codeload.github.com/hpcflow/install-scripts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245699284,"owners_count":20657987,"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":[],"created_at":"2025-01-31T22:21:21.986Z","updated_at":"2025-03-26T17:16:10.663Z","avatar_url":"https://github.com/hpcflow.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# install-scripts\n\nScripts to install the pyinstaller packaged versions of HPCFlow and MatFlow. There are four scripts:\n- `install-hpcflow.sh`: Install HPCFlow on a system running a UNIX based OS using BASH or ZSHRC (Linux or MacOS).\n- `install-hpcflow.ps1`: Install HPCFlow on a system running Windows using Powershell.\n- `install-matflow.sh`: Install MatFlow on a system running a UNIX based OS using BASH or ZSHRC (Linux or MacOS).\n- `install-matflow.ps1`: Install MatFlow on a system running Windows using Powershell.\n\nCurrently the UNIX verison of the installer is more fully featured than the Windows version.\n\n## Default behaviour\n\nWithout any parameters or flags specified the script behaves, it's behaviour is as follows.\n\n1. The latest stable release of the application in the \"one folder\" format is downloaded as a zip archive to a \ntemporary folder. \n\n2. The zip archive is extracted to a default installation folder. The installation folder depends on the OS.\n\n3. A symbolic link (Linux/macOS) or an alias (Windows) is created. This link has the same name as the downloaded \n    application.\n\n### Windows only \n\n### Linux/macOS only\n\n### Default install locations\n\n## Parameters and flags\n\nThe behaviour of the scripts can be configures using a series of parameters and flags. These are summarised below for \nthe two types of script. \n\n### Linux/MacOS\n\n#### Parameters\n\n- `--folder=FOLDER`: Specify the folder that the application will be installed to. Should be the absolute path.\n- `--version=VERSION`: Specify the version of the application that will be installed. Must be an official release.\n\n#### Flags\n\n- `--prerelease`: Specify that the latest pre-release version is installed.\n- `--purge`: Delete all installed versions of the application.\n- `--path`: Add the symlink folder to the path by adding a line to the end of `~/.bashrc` or `~/.zshrc`.\n- `--onefile`: Specify that the \"one file\" version should be installed.\n- `--univlink`: Specify that the symlink created has a universal rather than a versioned name.\n\n\n### Windows\n\n#### Parameters\n\n- `-Folder FOLDER`: Specify the folder that the application will be installed to. Should be the absolute path.\n\n#### Flags\n\n- `-OneFile`: Specify that the \"one file\" version should be installed.\n- `-PreRelease` Specify that the latest pre-release version should be installed.\n\n## Using the scripts\n\nThere are two ways that the scripts can be used.\n\n### Copy from remote and execute locally\n\nThe easiest way to use the script is to run one of the commands below that copy the script from GitHub and execute it.\n\nThe current recommended commands for HPCFlow under Linux/macOS is:\n```bash\n(touch tmp.sh \u0026\u0026 curl -fsSL https://raw.githubusercontent.com/hpcflow/install-scripts/main/src/install-hpcflow.sh \u003e tmp.sh \u0026\u0026 bash tmp.sh --prerelease --path) ; rm tmp.sh\n```\nand for MatFlow under Linux/macOS:\n```bash\n(touch tmp.sh \u0026\u0026 curl -fsSL https://raw.githubusercontent.com/hpcflow/install-scripts/main/src/install-matflow.sh \u003e tmp.sh \u0026\u0026 bash tmp.sh --prerelease --path) ; rm tmp.sh\n```\nThese commands download the code from the GitHub repo and place it in a file called `tmp.sh`, run the script with the \nrecommended settings, and then delete the file.\n\nThe corresponding commands for HPCFlow under Windows is:\n```powershell\n\u0026 $([scriptblock]::Create((New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/hpcflow/install-scripts/main/src/install-hpcflow.ps1'))) -PreRelease\n```\nand for MatFlow under Windows:\n```powershell\n\u0026 $([scriptblock]::Create((New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/hpcflow/install-scripts/main/src/install-matflow.ps1'))) -PreRelease \n```\n\nThese commands download the relevant code from the GitHub repo and execute it as a script block.\n\n### Clone the repository\n\nClone the repo using:\n```bash\ngit clone https://github.com/hpcflow/install-scripts.git\n```\nThe scripts can then be executed locally in Linux/macOS using:\n```bash\n./install-hpcflow.sh\n./install-matflow.sh\n```\nand in Windows (powershell) using:\n```powershell\n.\\install-hpcflow.ps1\n.\\install-matflow.ps1\n```\n\n\n\n\nThis repository contains scripts to install the pyinstaller folder version of \nhpcflow on a local machine running macOS or linux (through a bash or zsh \nterminal), or windows (through a powershell terminal).\n\nBy default the latest version is downloaded and placed in a suitable user\nspecific folder. A particular version and install folder can be specified too.\nThe user is provided with a prompt to add the install folder to their path to \nenable them to run hpcflow.\n\nTo install in macOS or linux, enter the following command in a terminal window:\n`/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/hpcflow/install-folder-version/main/install-hpcflow.sh)\"`\n\nTo set options, use:\n`curl -sSL https://raw.githubusercontent.com/hpcflow/install-folder-version/main/install-hpcflow.sh | folder=folder-var version=version-var bash`\n\nFor windows, enter the following command in a powershell window:\n`iex (iwr 'https://raw.githubusercontent.com/hpcflow/install-folder-version/main/install-hpcflow.ps1').Content`\n\nTo set options, use:\n`\u0026 $([scriptblock]::Create((New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/hpcflow/install-folder-version/main/install-hpcflow.ps1'))) -version version-value -folder folder-value`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhpcflow%2Finstall-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhpcflow%2Finstall-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhpcflow%2Finstall-scripts/lists"}