Skip to content

Commit 52e4d50

Browse files
committed
Updated documentation
1 parent 9d36424 commit 52e4d50

File tree

2 files changed

+14
-47
lines changed

2 files changed

+14
-47
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ then install using the following command.
1919
```text
2020
$ git clone [email protected]:DiamondLightSource/python-murfey.git
2121
$ cd python-murfey
22-
$ pip install -e .[client,server,developer]
22+
$ pip install -e .[server,developer]
2323
```
2424

2525
The packages included under the `[developer]` installation key contain some helpful tools to aid you with developing Murfey further:
@@ -43,7 +43,7 @@ $ murfey.server
4343
and connect the client with
4444

4545
```text
46-
$ murfey --server http://127.0.0.1:8000
46+
$ murfey.instrument_server --port 8000
4747
```
4848

4949
You can also install a client on a remote machine. This machine only needs to have

src/murfey/templates/bootstrap.html

Lines changed: 12 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
%} {% block content %}
33
<h1>Bootstrapping Instructions</h1>
44
<h2>1. Setting Up a POSIX Environment</h2>
5-
<h3>Installing MSYS2</h3>
5+
<h3>A. Installing MSYS2</h3>
66
<p>
77
MSYS2 is a POSIX environment which provides extensive compiler support for the
88
more modern programming languages used by Murfey's package dependencies.
@@ -14,9 +14,14 @@ <h3>Installing MSYS2</h3>
1414
<a href="{{ proxy_path }}/msys2/repo/distrib/msys2-x86_64-latest.exe"
1515
>mirror</a
1616
>, then run it using the default settings. This will install MSYS2 to
17-
C:\msys64.
17+
<span
18+
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
19+
>
20+
C:\msys64 </span
21+
>.
1822
</p>
19-
<h4>Setting Up the MSYS2 Package Manager (If Network-Restricted)</h4>
23+
<h3>B. Setting Up MSYS2</h3>
24+
<h4>i. Setting Up the MSYS2 Package Manager (If Network-Restricted)</h4>
2025
<p>
2126
By default, MSYS2 comes with preset lists of mirrors and servers that it
2227
installs its packages from. On a network-restricted PC, these will need to be
@@ -36,7 +41,7 @@ <h4>Setting Up the MSYS2 Package Manager (If Network-Restricted)</h4>
3641
>
3742
C:\msys64\etc\pacman.d
3843
</pre>
39-
<h4>Installing Dependencies</h4>
44+
<h4>ii. Installing Dependencies</h4>
4045
<p>
4146
MSYS2 comes with multiple environments, but UCRT64 is the most modern one. In
4247
order for the Murfey client to be able to install and run its dependencies
@@ -69,7 +74,7 @@ <h4>Installing Dependencies</h4>
6974
>pacman -Ss &lt;package-name&gt;</span
7075
>
7176
</p>
72-
<h4>Configuring the Rust Package Manager (If Network-Restricted)</h4>
77+
<h4>iii. Configuring the Rust Package Manager (If Network-Restricted)</h4>
7378
<p>
7479
Many newer Python packages now have dependencies written in Rust that allow
7580
them to operate more efficiently. MSYS2 supports the compilation and
@@ -132,30 +137,6 @@ <h4>Configuring the Rust Package Manager (If Network-Restricted)</h4>
132137
instead.
133138
</p>
134139

135-
<h4>Running MSYS2 Through Command Prompt</h4>
136-
<p>
137-
In order to run Murfey via the terminal, MSYS2 will have to be run through
138-
Window's Command Prompt terminal, as there is an ongoing bug with MSYS2's
139-
pre-packaged terminal that prevents mouse interaction with interactive apps in
140-
the terminal.
141-
</p>
142-
<p>
143-
To do so, simply right-click on your desktop and navigate to
144-
<span>New > Shortcut</span>. When prompted for the location of the item, enter
145-
the following into the text box:
146-
</p>
147-
<pre
148-
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
149-
>
150-
cmd.exe /k "C:\msys64\msys2_shell.cmd -defterm -no-start -ucrt64 -shell bash"
151-
</pre>
152-
<p>
153-
After naming the shortcut, click Finish to create the shortcut. This will run
154-
a UCRT64 instance of MSYS2 through the Command Prompt terminal that starts you
155-
off in MSYS2's default home directory. You can proceed to customise the
156-
shortcut icon to taste.
157-
</p>
158-
159140
<h2>2. Setting Up Python</h2>
160141
<p>
161142
Once Python and
@@ -180,25 +161,11 @@ <h3>A. (Optional) Setting Up a Virtual Environment</h3>
180161
<h3>B. Installing Murfey</h3>
181162
<p>
182163
You can install Murfey in the Python environment (the base one or a virtual
183-
environment) in either the Cygwin or UCRT64 terminal using the following
184-
commands:
164+
environment) in the UCRT64 terminal using the following commands:
185165
</p>
186166
<pre
187167
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
188168
>
189-
$ pip install murfey[client] --index-url {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/pypi/index --trusted-host {{ netloc }}
169+
$ pip install murfey --index-url {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/pypi/index --trusted-host {{ netloc }}
190170
</pre>
191-
<p>
192-
If you wish to install the client-side dependencies needed to run Murfey via
193-
the web UI, replace
194-
<span
195-
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
196-
>murfey[client]</span
197-
>
198-
with
199-
<span
200-
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
201-
>murfey[client,instrument-server]</span
202-
>.
203-
</p>
204171
{% endblock %}

0 commit comments

Comments
 (0)