Skip to content

Commit

Permalink
Update installation instructions (#626)
Browse files Browse the repository at this point in the history
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Cody Baker <[email protected]>
  • Loading branch information
3 people authored Feb 27, 2024
1 parent 30fec80 commit 374ed89
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
10 changes: 6 additions & 4 deletions docs/developer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Start by cloning the repository
Install Python Dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^


Install the appropriate Python dependencies for your operating system.

**Windows**
Expand All @@ -51,15 +50,19 @@ Install the appropriate Python dependencies for your operating system.
conda env create -f ./environments/environment-Linux.yml
Activate the Python Environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Before starting NWB GUIDE, you'll need to ensure that the Python environment is activated.

.. code-block:: bash
conda activate nwb-guide
Installing JavaScript Dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install JavaScript Dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Next, install all JavaScript dependencies based on the `package-lock.json` file.

Expand All @@ -78,7 +81,6 @@ You can now run the following command to start the application using Electron.
npm start
Repo Structure
--------------
1. **src/renderer/src** - Contains all the source code for the frontend
Expand Down
17 changes: 11 additions & 6 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,27 @@ Installation
Windows
-------

Download and run the `NWB-GUIDE-Setup-vX.Y.Z.exe <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-x64.exe>`_ file and follow all instruction prompts.
Download and run `NWB-GUIDE-x64.exe <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-x64.exe>`_ and follow all instruction prompts.

MacOS - Intel
-------------

Download the `NWB-GUIDE-vX.Y.Z.dmg <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-x64.dmg>`_ file, which should prompt you to move it into your 'Applications' folder in order to run.
Download `NWB-GUIDE-x64.dmg <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-x64.dmg>`_, which should prompt you to move it into your 'Applications' folder in order to run.

MacOS - Apple Silicon
---------------------

Download the `NWB-GUIDE-vX.Y.Z-arm64.dmg <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-arm64.dmg>`_ file, which should prompt you to move it into your 'Applications' folder in order to run.
Download `NWB-GUIDE-arm64.dmg <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-arm64.dmg>`_, which should prompt you to move it into your 'Applications' folder in order to run.

.. note::
Some data formats can have issues using this build of the application. If you encounter errors when using a particular interface, try following the advanced :ref:`Developer Installation instructions<developer_installation>` instructions.

Ubuntu
------
Linux
-----

Please clone the :linux-fix:`linux-fix <>` branch of the NWB GUIDE and follow the :ref:`Developer Installation instructions<developer_installation>` on this documentation after the "Clone the Repo" step.
Please clone the :linux-fix:`linux-fix <>` branch of the NWB GUIDE and follow the :ref:`Developer Installation instructions<developer_installation>` after the "Clone the Repo" step.

.. code-block:: bash
git clone --branch linux-fix https://github.com/NeurodataWithoutBorders/nwb-guide
cd nwb-guide

0 comments on commit 374ed89

Please sign in to comment.