Skip to content

Commit

Permalink
Documentation: Revise manual instructions
Browse files Browse the repository at this point in the history
We now explain how to get the source code, mention that we also have a
release package and list the JSON configuration folder locations.
  • Loading branch information
t-b committed Oct 14, 2024
1 parent c62f6a1 commit e7e5a25
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 11 deletions.
12 changes: 8 additions & 4 deletions Packages/doc/developers.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
Developer
=========

.. _getting MIES:

Getting MIES
------------

Latest development version from main branch
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Cloning the MIES repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~

- ``git clone --recurse-submodules https://github.com/AllenInstitute/MIES``
- ``./tools/initial-repo-config.sh`` (Requires a Git Bash shell, named
Git terminal in SourceTree)
- ``./tools/initial-repo-config.sh`` (Requires a Git Bash/Terminal)

If you only want to **use** MIES and not **develop** it, you can also get the source
code via the `release package <https://github.com/AllenInstitute/MIES/releases>`__ as zip file.

Building the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
26 changes: 19 additions & 7 deletions Packages/doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,9 @@ install via the Installer package.
Windows (with hardware support)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Install the `Visual C++ Redistributable package` <https://github.com/AllenInstitute/MIES/blob/main/tools/installer/vc_redist.x64.exe>`__.

- Install the `Visual C++ Redistributable package <https://github.com/AllenInstitute/MIES/blob/main/tools/installer/vc_redist.x64.exe>`__
- Quit Igor Pro
- Get the MIES source code, see :ref:`getting MIES`
- Create the following shortcuts in ``C:\Users\$username\Documents\WaveMetrics\Igor Pro 9 User Files``

- In ``User Procedures`` a shortcut pointing to
Expand All @@ -175,9 +175,9 @@ Windows (without hardware)
In case you don't have the hardware connected/available which some XOPs
require, you can also install MIES without any hardware related XOPs present.

Install the `Visual C++ Redistributable package` <https://github.com/AllenInstitute/MIES/blob/main/tools/installer/vc_redist.x64.exe>`__.

- Install the `Visual C++ Redistributable package <https://github.com/AllenInstitute/MIES/blob/main/tools/installer/vc_redist.x64.exe>`__
- Quit Igor Pro
- Get the MIES source code, see :ref:`getting MIES`
- Create the following shortcuts in
``C:\Users\$username\Documents\WaveMetrics\Igor Pro 9 User Files``

Expand Down Expand Up @@ -206,9 +206,7 @@ MacOSX (without hardware)
Analysis support only. Data acquisition and NWBv2 export are not supported on MacOSx.

- Quit Igor Pro
- Get the MIES source code, see
`here <https://alleninstitute.github.io/MIES/developers.html#latest-development-version-from-main-branch>`__
for instructions.
- Get the MIES source code, see :ref:`getting MIES`
- Create the following symlinks in
``/Users/$username/Documents/WaveMetrics/Igor Pro 9 User Files``

Expand All @@ -226,3 +224,17 @@ Analysis support only. Data acquisition and NWBv2 export are not supported on Ma
- In ``Igor Help Files`` a shortcut pointing to HelpFiles-IP9

- Start Igor Pro

JSON Configuration folders
~~~~~~~~~~~~~~~~~~~~~~~~~~

MIES supports JSON files for loading and storing panel configurations. Although it is
possible to load files from arbitrary paths manually, one can also put the
files into one of the following folders

- ``Packages/Settings`` in the installation location

- ``C:/ProgramData/AllenInstitute/MIES/Settings``

to execute all of them via :menuselection:`MIES Panels --> Automation --> Load standard configuration`
or by pressing :kbd:`CONTROL-1`.

0 comments on commit e7e5a25

Please sign in to comment.