Skip to content

Commit 3db2b94

Browse files
author
Billy Charlton
committed
docs
1 parent 43aa43e commit 3db2b94

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

docs/intro-running-locally.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,26 @@ This is the easiest solution for most situations. SimWrapper has been packaged a
1414
**Shortest path to a running local installation:**
1515

1616
Use the [uv software manager](https://docs.astral.sh/uv/). uv is the modern replacement for all previous python software management tools like pip, poetry, virtualenv, etc. It eliminates the problems with virtual environments, messy multiple Python versions, etc. It is far, far faster and more error-proof than using pip or other methods!
17-
- Install uv first if you don't already have it:
17+
- (1) Install uv first if you don't already have it:
1818
https://docs.astral.sh/uv/getting-started/installation
19-
- uv will use your local install of Python. If you don't have Python or have an old Python < 3.8, let uv install a recent python for you (no, this won't mess up any of your existing python installations!):
20-
- `uv python install 3.11`
21-
- Go to the folder containing the data you want to explore, and run
22-
- `uvx simwrapper run`
23-
- There's no step 3! SimWrapper is now running at http://127.0.0.1:4999 or http://localhost:4999
19+
- Read the output from the install command; you might need to edit your PATH to include the program.
20+
- uv will use your local install of Python. If you don't have Python or have a very old Python < 3.6, let uv install a recent python for you (no, this won't mess up any of your existing python installations!):
21+
- `uv python install 3.11`
22+
- (2) Install the simwrapper command-line tool using uv:
23+
- `uv tool install simwrapper`
24+
- (3) Go to the folder containing your data and run:
25+
- `simwrapper run`
2426

25-
`uvx` is a combined installer/command runner that will auto install the simwrapper tool from https://pypi.org/project/simwrapper/ on first run. Each time it runs, it will check for the latest version and update automatically. In offline mode it runs the most recent version that it has already installed.
26-
- Read the [uv docs](https://docs.astral.sh/uv/) for many other uv capabilities such as `uv tool install simwrapper` and managing your pip dependencies and python versions!
27+
That's it! Your site is running at http://127.0.0.1:4999
28+
29+
Read the [uv docs](https://docs.astral.sh/uv/) for many other uv capabilities such as `uv tool install simwrapper` and managing your pip dependencies and python versions!
2730

2831
**pip**
2932

3033
You can also use pip directly, with `pip install simwrapper`. If you go this route, you should
3134
probably create a virtualenv (venv) and make sure you have a recent version of Python. These extra
3235
steps can be a real pain, especially because SimWrapper has many data science dependencies which are
33-
difficult to install. Please use `uv` instead, as above :-)
36+
difficult to install. Please use `uv` instead, as above :-)
3437

3538

3639
### Use Docker
@@ -39,7 +42,7 @@ SimWrapper is available as a built Docker image at https://hub.docker.com/r/simw
3942

4043
Let's assume you already know how to use Docker if you are reading this!
4144

42-
- `docker pull simwrapper/app`
45+
- `docker pull simwrapper/app`
4346
- `docker run -p 4999:4999 -v /my/data/folder:/data simwrapper/app`
4447

4548
The `-p` tells docker to listen on port 4999; `-v` links your local folder of files to `/data` in

0 commit comments

Comments
 (0)