Skip to content

Commit aee2bd6

Browse files
committed
updating notes for PYMEnf, other auxiliary packages
1 parent 51320ee commit aee2bd6

File tree

4 files changed

+14
-2
lines changed

4 files changed

+14
-2
lines changed

Installing-PYME-with-py3-macos.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,3 +128,6 @@ This should bring up dh5view with a small image containing random noise, as show
128128

129129
![dh5view-test](images/dh5view-test.png)
130130

131+
##### Build other auxiliary packages
132+
133+
We have a few additional auxiliary packages, such as `PYME-extra`, `PYMEnf` and `PYME-cs-siteconfig` plus some sample data (`PYME-extra-example-data`). We have [installation notes](Installing-PYMEnf.md) for `PYMEnf`. `PYME-extra` is covered in the [PYME windows installation notes](Installing-PYME-with-py3-win10.md). `PYME-cs-siteconfig` has [its own notes](PYMEAcquire/PYME-cs-siteconfig.md) in the `PYMEAcquire` section of these installation notes.

Installing-PYME-with-py3-win10.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,9 @@ Note that we leave out the ```dist``` argument in the plugin install call since
189189

190190
6. Test: At this stage you should bring up visgui again, say, and check that all the expected extra menus are available. [*Note to self, show what menus should be available*]
191191

192+
##### Optional: build PYMEnf
193+
194+
Local users may want to install and build `PYMEnf` that contains a few select non-free plugins (which we cannot easily make public due to licensing constraints). Details are in the [PYMEnf installation notes](Installing-PYMEnf.md).
192195

193196
#### 6. Make a few shortcut files and launchers
194197

Installing-PYMEnf.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Unzip the pymenf code
44

5-
I have resorted to distributing the PYMEnf code via a zip archive (long story why this is not shared via github at the moment). The file ```pymenf.zip``` is available from our ```CS lab``` Teams group chat in the ```Files``` section.
5+
I have resorted to distributing the PYMEnf code via a zip archive (long story why this is not publicly shared via github at the moment). A zip file of ```PYMEnf``` named with `pymenf` and a date in the name can be found in the `PYMEnf` subdirectory of our shared OneDrive folder with microscopy related stuff.
66

7-
Get the archive from there and unpack into the same directory that has already the ```python-microscopy``` and ```PYME-extra``` repos in it. Unpacking it should create a new folder ```pymenf```.
7+
Get the archive from there and unpack into the same directory that has already the ```python-microscopy``` and ```PYME-extra``` repos in it. Unpacking it should create a new folder ```pymenf-master``` (the `master` bit refers to this stemming from the `master` branch of the repo).
88

99

1010
## Build the pymenf code

PYMEAcquire/PYME-cs-siteconfig.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ This is done using
1616

1717
We generally pick these up via the [launcher scripts](../PYME-windows-launchers.md) which include a path to the init file location.
1818

19+
## Launcher scripts
20+
21+
The launcher scripts are generally installed by creating shortcuts to the relevant set of files from the repo and moving these shortcuts to the public desktop. See also the launcher related instructions about the [main setup with conda](conda-setup.md).
22+
23+
**TODO**: make a script to autogenerate and move the shortcuts to the public desktop.
24+
1925
## Dye Ratios
2026

2127
The repo also contains a file with dye ratios for a number of splitter dichroics.

0 commit comments

Comments
 (0)