diff --git a/Packages/doc/developers.rst b/Packages/doc/developers.rst index 004fef942c..45c73d06fd 100644 --- a/Packages/doc/developers.rst +++ b/Packages/doc/developers.rst @@ -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 `__ as zip file. Building the documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/Packages/doc/installation.rst b/Packages/doc/installation.rst index 7f266dd9eb..4cc05153bd 100644 --- a/Packages/doc/installation.rst +++ b/Packages/doc/installation.rst @@ -151,9 +151,9 @@ install via the Installer package. Windows (with hardware support) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Install the `Visual C++ Redistributable package` `__. - +- Install the `Visual C++ Redistributable package `__ - 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 @@ -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` `__. - +- Install the `Visual C++ Redistributable package `__ - 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`` @@ -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 `__ - 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`` @@ -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`.