Production installation

Pre installation

This application comes with a requirement for node version 16.16, please install that node version or nvm (macos installation or linux installation) to manage multiple node version.

In order to being able to run successfully PsyNeuLinkView you will need to follow the steps below

• Create a conda environment

conda create --name psnl_viewer python=3.7

• Activate the conda environment just created

conda activate psnl_viewer

• Make the pre_installation.sh script executable

chmod +x pre_installation.sh

• Run the pre_installation script that will take care of installing PsyNeuLink

bash pre_installation.sh

• Download the packaged version of the software from the releases page link, then

MacOS

• Open your terminal and navigate to the folder containing the archive osx.tar.gz previously downloaded

• Open the archive and then navigate in the app folder with the commands below

  tar xvfz osx.tar.gz
  cd PsyNeuLinkViewer-darwin-x64/PsyNeuLinkViewer.app/Contents/MacOS/
  

• Before to launch the application ensure that you are running the node version required, so

  node --version
  

  and if this is different from v16.16 then either follow the steps at the top or run

  nvm use 16.16
  

• Now you can run the application

  ./PsyNeuLinkViewer
  

Linux

• Open your terminal and navigate to the folder containing the archive linux.tar.gz previously downloaded

• Open the archive and then navigate in the app folder with the commands below

  tar xvfz linux.tar.gz
  cd PsyNeuLinkViewer-linux-x64/
  

• Before to launch the application ensure that you are running the node version required, so

  node --version
  

  and if this is different from v16.16 then either follow the steps at the top or run

  nvm use 16.16
  

• Now you can run the application

  ./PsyNeuLinkViewer
  

Development Installation

Requirements

• it requires node version ^14.21.0 I would suggest to install nvm if you have a different node version so you can manage multiple node versions, installation steps here
• it requires yarn (follow the installation instructions)
• it requires yalc (follow the installation instructions)

Installation

• Close this repository

git clone -b metacell https://github.com/MetaCell/PsyNeuLinkView

• At the same level of the above repository clone meta-diagram

git clone -b develop https://github.com/MetaCell/meta-diagram/

• Ensure yarn and yalc are installed in your machine, otherwise the installation script will fail.
• Cd inside the PsyNeuLinkView repository folder

cd PsyNeuLinkView

• run the installation script

chmod +x installation.sh
./installation.sh -i

Usage

• If you need to work purely on the frontend you can run:

yarn run start:dev

• If you need to work on the entire flow of the application you must start it with:

yarn run dev