Skip to content

improve scripts/install.sh #2914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 10, 2025
Merged

improve scripts/install.sh #2914

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51cde19
improve script (add venv)
Jun 10, 2025
5d5e098
improve script
Jun 10, 2025
ec6de22
improve script
Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 41 additions & 30 deletions scripts/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

#!/bin/bash
set -u

# enable command completion
# enable command completion
set -o history -o histexpand

python="python3"
Expand Down Expand Up @@ -34,7 +33,6 @@ wait_for_user() {
echo
echo "Press RETURN to continue or any other key to abort"
getc c
# we test for \r and \n because some stuff does \r instead
if ! [[ "$c" == $'\r' || "$c" == $'\n' ]]; then
exit 1
fi
Expand Down Expand Up @@ -67,12 +65,8 @@ ohai() {
printf "${tty_blue}==>${tty_bold} %s${tty_reset}\n" "$(shell_join "$@")"
}

# Things can fail later if `pwd` doesn't exist.
# Also sudo prints a warning message for no good reason
cd "/usr" || exit 1

linux_install_pre() {
sudo apt-get update
sudo apt-get update
sudo apt-get install --no-install-recommends --no-install-suggests -y apt-utils curl git cmake build-essential
exit_on_error $?
}
Expand All @@ -86,41 +80,48 @@ linux_install_python() {
ohai "Updating python"
sudo apt-get install --only-upgrade $python
fi
exit_on_error $?
exit_on_error $?
ohai "Installing python tools"
sudo apt-get install --no-install-recommends --no-install-suggests -y $python-pip $python-dev
exit_on_error $?
sudo apt-get install --no-install-recommends --no-install-suggests -y python3-pip python3-dev python3-venv
exit_on_error $?
}

linux_update_pip() {
PYTHONPATH=$(which $python)
ohai "You are using python@ $PYTHONPATH$"
ohai "Installing python tools"
$python -m pip install --upgrade pip
ohai "Skipping pip upgrade in system Python (PEP 668). Will upgrade inside virtual environment."
}


linux_install_bittensor() {
ohai "Cloning bittensor@master into ~/.bittensor/bittensor"
mkdir -p ~/.bittensor/bittensor
git clone https://github.com/opentensor/bittensor.git ~/.bittensor/bittensor/ 2> /dev/null || (cd ~/.bittensor/bittensor/ ; git fetch origin master ; git checkout master ; git pull --ff-only ; git reset --hard ; git clean -xdf)
git clone https://github.com/opentensor/bittensor.git ~/.bittensor/bittensor/ 2> /dev/null || \
(cd ~/.bittensor/bittensor/ ; git fetch origin master ; git checkout master ; git pull --ff-only ; git reset --hard ; git clean -xdf)

ohai "Creating Python virtual environment"
python3 -m venv ~/.bittensor/venv
$HOME/.bittensor/venv/bin/python -m ensurepip --upgrade
source ~/.bittensor/venv/bin/activate
python="$HOME/.bittensor/venv/bin/python"

ohai "Installing bittensor"
$python -m pip install --upgrade pip
$python -m pip install -e ~/.bittensor/bittensor/
$python -m pip install -U bittensor-cli
exit_on_error $?
exit_on_error $?
deactivate
}

linux_increase_ulimit(){
ohai "Increasing ulimit to 1,000,000"
prlimit --pid=$PPID --nofile=1000000
}


mac_install_xcode() {
which -s xcode-select
if [[ $? != 0 ]] ; then
ohai "Installing xcode:"
xcode-select --install
exit_on_error $?
exit_on_error $?
fi
}

Expand All @@ -133,7 +134,7 @@ mac_install_brew() {
ohai "Updating brew:"
brew update --verbose
fi
exit_on_error $?
exit_on_error $?
}

mac_install_cmake() {
Expand All @@ -153,7 +154,7 @@ mac_install_python() {
brew list python@3 &>/dev/null || brew install python@3;
ohai "Updating python3"
brew upgrade python@3
exit_on_error $?
exit_on_error $?
}

mac_update_pip() {
Expand All @@ -165,11 +166,20 @@ mac_update_pip() {

mac_install_bittensor() {
ohai "Cloning bittensor into ~/.bittensor/bittensor"
git clone https://github.com/opentensor/bittensor.git ~/.bittensor/bittensor/ 2> /dev/null || (cd ~/.bittensor/bittensor/ ; git fetch origin master ; git checkout master ; git pull --ff-only ; git reset --hard; git clean -xdf)
git clone https://github.com/opentensor/bittensor.git ~/.bittensor/bittensor/ 2> /dev/null || \
(cd ~/.bittensor/bittensor/ ; git fetch origin master ; git checkout master ; git pull --ff-only ; git reset --hard; git clean -xdf)

ohai "Creating Python virtual environment"
python3 -m venv ~/.bittensor/venv
$HOME/.bittensor/venv/bin/python -m ensurepip --upgrade
source ~/.bittensor/venv/bin/activate
python="$HOME/.bittensor/venv/bin/python"

ohai "Installing bittensor"
$python -m pip install --upgrade pip
$python -m pip install -e ~/.bittensor/bittensor/
$python -m pip install -U bittensor-cli
exit_on_error $?
exit_on_error $?
deactivate
}

Expand All @@ -178,11 +188,12 @@ OS="$(uname)"
if [[ "$OS" == "Linux" ]]; then

which -s apt-get
if [[ $? == 0 ]] ; then
if [[ $? != 0 ]] ; then
abort "This linux based install requires apt-get. To run with other distros (centos, arch, etc), you will need to manually install the requirements"
fi

echo """

██████╗░██╗████████╗████████╗███████╗███╗░░██╗░██████╗░█████╗░██████╗░
██╔══██╗██║╚══██╔══╝╚══██╔══╝██╔════╝████╗░██║██╔════╝██╔══██╗██╔══██╗
██████╦╝██║░░░██║░░░░░░██║░░░█████╗░░██╔██╗██║╚█████╗░██║░░██║██████╔╝
Expand Down Expand Up @@ -260,7 +271,7 @@ fi

# Use the shell's audible bell.
if [[ -t 1 ]]; then
printf "\a"
printf "\a"
fi

echo ""
Expand Down Expand Up @@ -289,12 +300,12 @@ echo " $ btcli w new_hotkey"
echo " $ btcli w list"
echo " $ btcli s register"
echo ""
echo "- Check Bittensor SDK version"
echo " $ python -m bittensor"
echo ""
echo "- Use the Python API"
echo " $ python3"echo " >> import bittensor"
echo ""
echo "- Join the discussion: "
echo "- Join the discussion:"
echo " ${tty_underline}https://discord.gg/3rUr6EcvbB${tty_reset}"
echo ""