Skip to content

Commit

Permalink
Update stale references to run_pooltool
Browse files Browse the repository at this point in the history
  • Loading branch information
ekiefl committed Jul 21, 2024
1 parent 9e50379 commit d07d53e
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 26 deletions.
2 changes: 1 addition & 1 deletion PYPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ If test PyPi is timing out, you can instead consider testing the installation wi
pip install dist/pooltool-billiards-X.X.X.dev0.tar.gz --force-reinstall
```

- Test it out. Make sure `cd ~; which run_pooltool` leads to the asdf environment: `/Users/evan/anaconda3/envs/asdf/bin/run_pooltool`. Then see if it works: `run_pooltool`. Additionally, check the path of `python -c "import pooltool; print(pooltool.__file__)"`. It should be in site-packages of asdf environment.
- Test it out. Make sure `which run-pooltool` leads to the asdf environment: `/Users/evan/anaconda3/envs/asdf/bin/run_pooltool`. Then see if it works: `run-pooltool`. Additionally, check the path of `cd ~; python -c "import pooltool; print(pooltool.__file__)"; cd -`. It should be in site-packages of asdf environment.

## 4. Rebuild with correct version tag

Expand Down
22 changes: 1 addition & 21 deletions docs/getting_started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,31 +120,11 @@ pre-commit install
**(vi)** test out your installation:

```bash
python run_pooltool
run-pooltool
```

The game window should appear (escape key to exit).

**(vi)** if you used a conda environment that you named `pooltool`, create this script that runs whenever the conda environment is activated. This script modifies `$PATH` and `$PYTHONPATH` so that python knows where to find pooltool libraries and the shell knows where to find the pooltool binary. **These path modifications live safely inside the pooltool conda environment, and do not propagate into your global
environment**:

(_This is a multi-line command. Paste the entire block into your command line prompt._)

```
mkdir -p ${CONDA_PREFIX}/etc/conda/activate.d
cat <<EOF >${CONDA_PREFIX}/etc/conda/activate.d/pooltool.sh
export PYTHONPATH=\$PYTHONPATH:$(pwd)
export PATH=\$PATH:$(pwd)
EOF
```

The next time you activate your conda environment (`conda activate pooltool`), `run_pooltool` (or `run_pooltool.bat` if you're on Windows) is now a binary that can be run anywhere in your filesystem whenever you are in the `pooltool` conda environment. Test it out:
```
conda activate pooltool
cd ~
run_pooltool
```

</details>

## Next
Expand Down
6 changes: 3 additions & 3 deletions docs/getting_started/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
The interface (GUI) can be accessed from the command line:

```bash
run_pooltool
run-pooltool
```

Or, if you're on Windows:
Or, if you're on Windows (FIXME is this true?):

```bash
run_pooltool.bat
run-pooltool.bat
```

This will produce the following window:
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/custom_physics.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ transition: canonical
transition_params: {}
```
The resolver configuration file is automatically generated during the initial execution. If you don't have one yet, execute pooltool with the command `run_pooltool`, start a new game, and take a shot--one will be generated.
The resolver configuration file is automatically generated during the initial execution. If you don't have one yet, execute pooltool with the command `run-pooltool`, start a new game, and take a shot--one will be generated.

Models are identified by their names. You can view the names of all available models by executing the following command:

Expand Down

0 comments on commit d07d53e

Please sign in to comment.