Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
justanhduc committed Jul 8, 2022
1 parent 0884a52 commit e4878c7
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 57 deletions.
61 changes: 61 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Install Task Spooler

First, clone the repository

```
git clone https://github.com/justanhduc/task-spooler
```

To setup Task Spooler with GPU support, one needs to set a `CUDA_HOME` environment variable.
Otherwise, if you need only the CPU version, perform a checkout first

```
git checkout cpu-only
```

Then, simple run the provided script

```
./install_cmake
```
to use CMake, or
```
./install_make
```
to use Makefile. If Task Spooler has already been installed,
and you want to reinstall or upgrade, you can run

```
./reinstall
```

## Local installation
To install without sudo privilege, one can use the following command
```
make install-local
```

Note that, the installation will create a `bin` folder in `$HOME` if it does not exist.
To use `ts` anywhere, `$HOME/bin` needs to be added to `$PATH` if it hasn't been done already.
To use `man`, you may also need to add `$HOME/.local/share/man` to `$MANPATH`.

## Common problems
* Cannot find CUDA: Did you set a `CUDA_HOME` flag?
* ~~`/usr/bin/ld: cannot find -lnvidia-ml`: This lib lies in `$CUDA_HOME/lib64/stubs`.
Please append this path to `LD_LIBRARY_PATH`.
Sometimes, this problem persists even after adding the lib path.
Then one can add `-L$(CUDA_HOME)/lib64/stubs` to [this line](./Makefile#L29) in the Makefile.~~
* `list.c:22:5: error: implicitly declaring library function 'snprintf' with type 'int (char *, unsigned long, const char *, ...)'`:
Please remove `-D_XOPEN_SOURCE=500 -D__STRICT_ANSI__` in the Makefile as reported [here](https://github.com/justanhduc/task-spooler/issues/4).
* `Error calling recv_msg in c_check_version` and/or `Wrong server version`: This is because another version of `ts`
is still running. If you want to upgrade, please use the `reinstall` script as instructed above.
If you installed `ts` via `apt` before, you have to uninstall it and remove the server
file in `/tmp` first before installing this `ts`.
For more info, see [here](https://github.com/justanhduc/task-spooler/issues/6) and [here](https://github.com/justanhduc/task-spooler/issues/21).

# Uinstall Task Spooler

```
./uninstall
```
Why would you want to do that anyway?
60 changes: 3 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,70 +47,16 @@ At the end, after some time using and developing ts, it can do something more:

## Setup

### Install Task Spooler

First, clone the repository

```
git clone https://github.com/justanhduc/task-spooler
```

To setup Task Spooler with GPU support, one needs to set a `CUDA_HOME` environment variable.
Otherwise, if you need only the CPU version, perform a checkout first

```
git checkout cpu-only
```

Then, simple run the provided script

```
./install_cmake
```
to use CMake, or
```
./install_make
```
to use Makefile. If Task Spooler has already been installed, and you want to reinstall, execute

```
./reinstall
```

#### Local installation
To install without sudo privilege, one can use the following command
```
make install-local
```

Note that, the installation will create a `bin` folder in `$HOME` if it does not exist.
To use `ts` anywhere, `$HOME/bin` needs to be added to `$PATH` if it hasn't been done already.
To use `man`, you may also need to add `$HOME/.local/share/man` to `$MANPATH`.

#### Common problems
* Cannot find CUDA: Did you set a `CUDA_HOME` flag?
* `/usr/bin/ld: cannot find -lnvidia-ml`: This lib lies in `$CUDA_HOME/lib64/stubs`.
Please append this path to `LD_LIBRARY_PATH`.
Sometimes, this problem persists even after adding the lib path.
Then one can add `-L$(CUDA_HOME)/lib64/stubs` to [this line](./Makefile#L29) in the Makefile.
* list.c:22:5: error: implicitly declaring library function 'snprintf' with type 'int (char *, unsigned long, const char *, ...)': Please remove `-D_XOPEN_SOURCE=500 -D__STRICT_ANSI__` in the Makefile as reported [here](https://github.com/justanhduc/task-spooler/issues/4).


### Uinstall Task Spooler

```
./uninstall
```
Why would you want to do that anyway?
See the installation steps in [INSTALL.md](INSTALL.md).

## Known issues

- This is not an issue, but when multiple consecutive GPU jobs are queued,
- ~~This is not an issue, but when multiple consecutive GPU jobs are queued,
after the first job runs, there is a small delay for the next GPU job to run
in order to ensure that the same GPUs are not claimed by different jobs.
There was an issue causing this delay significantly longer as reported in [`#2`](https://github.com/justanhduc/task-spooler/issues/2)
but has been fixed in [176d0b76](https://github.com/justanhduc/task-spooler/commit/176d0b76).
To avoid the delay, you can use `-g` to indicate the exact GPU IDs for the job.
To avoid the delay, you can use `-g` to indicate the exact GPU IDs for the job.~~


## Mailing list
Expand Down

0 comments on commit e4878c7

Please sign in to comment.