Skip to content
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

Update README.md to reflect more common installation requirements #175

Merged
merged 1 commit into from
Jan 22, 2025
Merged

Update README.md to reflect more common installation requirements #175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 23 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@ acyclic graphs (DAGs), and execution on batch schedulers (Slurm).
* [Templates](docs/templates.md)
- [Vignette](#vignette)
- [Installation](#installation)
* [Troubleshooting: Command not found after install](#troubleshooting--command-not-found-after-install)
* [Install with Pip](#install-with-pip)
* [Troubleshooting: Command not found after install](#troubleshooting-command-not-found-after-install)


# Getting Started

Jetstream can be installed with Pip:

```shell
pip install git+https://github.com/tgen/jetstream.git@master
pip3 install git+https://github.com/tgen/jetstream.git@master
```

After installing with Pip, the command line utility can be launched with
Expand Down Expand Up @@ -300,19 +301,30 @@ jetstream tasks -v

# Installation

> TGen users on Diamondback can load the latest version of Python with
`module load Python` though it is recommended to check which modules
are available via `module avail Python` and using a specific module.
> TGen users on Gemini should use `module load python37` as this already has
many dependencies preinstalled and is currently used in production. Additional
installation help can be found in this [`presentation`][presentation]

This is a Python package and requires Python3 (>=3.7). Installation guides for
Mac/Windows/Linux are available from the
[Hitchiker's Guide to Python][install_help] After Python3 is installed, you can
install Jetstream with Pip (next step).
Mac/Windows/Linux are available from the [Hitchiker's Guide to Python][install_help].
After Python3 is installed, you can install Jetstream with Pip (next step).

Install with Pip
## Install with Pip

_It is recommended to install a specific release tag_:
```shell
pip install git+https://github.com/tgen/jetstream.git@master
pip3 install git+https://github.com/tgen/[email protected]
```

Optionally, jetstream can be installed via a branch name:
```shell
pip3 install git+https://github.com/tgen/jetstream.git@master
```

For most users in an HPC environment, installing to /usr/bin will not be possible
due to permissions. In this case we will need to add `--user` to the pip3 command:
```shell
pip3 install --user git+https://github.com/tgen/[email protected]
```

## Troubleshooting: Command not found after install
Expand Down Expand Up @@ -346,3 +358,4 @@ where these scripts are stored.
[PATH]: http://www.linfo.org/path_env_var.html
[install_help]: http://docs.python-guide.org/en/latest/starting/installation/
[path_help]: https://stackoverflow.com/questions/35898734/pip-installs-packages-successfully-but-executables-not-found-from-command-line
[presentation]: https://docs.google.com/presentation/d/1Xd6SYaLW6ka1xXE1f8I3bH1LQYNg1-NE-j5wg9eKHrU/edit?usp=sharing
Loading