Quick Reference#

  1. A user must have an IN-CORE account. If you do not have it, see IN-CORE Account section for setting one.

  2. Install Miniconda or Anaconda virtual environment. Download the latest Miniconda3 installer from the Miniconda web page or Anaconda3 installer from Anaconda page.

  3. From the Terminal (Mac/Linux) or Command Prompt (Windows) add conda-forge package repository/channel to your environment:

    conda config --add channels conda-forge
    
  4. Create the python environment (for this example we choose pyincoreEnv):

    conda create -n pyincoreEnv python=3.9
    
  5. Activate the environment:

    conda activate pyincoreEnv
    
  6. To install pyIncore, navigate to the directory you want to use for running Jupyter Notebooks and run the following command. This will install both, pyIncore-viz and pyIncore as a dependency.

    conda install -c in-core pyincore-viz
    

    If the installed pyincore or pyincore-viz version is not the latest or lower than the desired one, specify the version number in installation command.

    conda install -c in-core pyincore-viz=1.8.3 (or your version of choice)
    

    Version information for pyincore and pyincore-viz can be found in

    • https://anaconda.org/IN-CORE/pyincore

    • https://anaconda.org/IN-CORE/pyincore-viz

  7. Install Jupyter Notebook. Jupyter Notebook is already installed with Anaconda distribution; it has to be installed separately in your virtual environment on Miniconda:

    conda install jupyter