Installation

Important

Starting from version 1.1.0, python 2 is not supported anymore. Python >=3.7 is suggested, older python 3 versions (<3.7) should work.

Windows 10 prerequisites

Install the Windows Subsystem for Linux: https://docs.microsoft.com/en-us/windows/wsl/install-win10

Install JetSeT from Anaconda

to get anaconda: https://www.anaconda.com/download/

• create a virtual environment (not necessary, but suggested):

  conda create --name jetset python=3.9 ipython jupyter
  

  conda activate jetset
  

• install the code

  conda install -c andreatramacere -c astropy -c conda-forge 'jetset>=1.2'
  

• run the test (optional)

  pytest --disable-warnings  --pyargs  -vvv jetset.tests.test_users::TestUser
  

Install JetSeT from pip

• create a virtual environment (not necessary, but suggested):

  pip install virtualenv
  
  virtualenv -p python3.9 jetset
  
  source jetset/bin/activate
  
  pip install ipython jupyter
  

• MacOS

  pip install jetset
  

• Linux

  Important

  LINUX: currently, pip binaries for linux are not provided, so pip will build the binary on the fly. Hence: install swig following the Swig installation method, and check that you have a C compiler (gcc) then

  pip install jetset
  

  if fails, use one of the following methods

  -) Use anaconda

  OR

  -) Install from source

  OR

  -) Use the git release binaries follow the instructions here: Install GitHUb releases

• run the test (optional)

  pytest --disable-warnings  --pyargs  -vvv jetset.tests.test_users::TestUser
  

Install binaries from GitHUb

To use the git release binaries, follow the instructions here: Install GitHUb releases

Install the JetSeT from source

Download the code

• Get the source code from: https://github.com/andreatramacere/jetset/archive/stable.tar.gz

• Uncompress the archive: jetset-stable.tar.gz

• cd to the dir source code dir

  cd jetset-stable
  

Installation from source using Anaconda

• Install requirements, run on the command line:

  conda install --yes   swig">=3.0.0"
  
  conda install -c astropy -c conda-forge --file requirements.txt
  

Important

if anaconda fails to install swig, you can try one of the following alternative Swig installation

• run on the command line

  python setup.py clean
  
  python setup.py install
  

• run the test (optional, run all the examples outside the installation dir)

  cd ~/
  
  mkdir test_jetset
  
  cd test_jetset
  
  pytest --disable-warnings  --pyargs  -vvv jetset.tests.test_users::TestUser
  

Installation from source using PIP

• Install requirements, run on the command line:

  pip install swig>=3.0.0
  
  pip install -r requirements.txt
  

Important

if pip fails to install swig, you can try one of the following alternative Swig installation

• Install JetSeT: run on the command line:

  python setup.py clean
  
  python setup.py install
  

• run the test (optional, run all the examples outside of the installation dir)

  cd ~/
  mkdir test_jetset
  cd test_jetset
  pytest  --pyargs  -vvv jetset.tests.test_users::TestUser
  

To install from source a C compiler is also necessary, plus the SWIG wrapper generator.

All the dependencies are installed following the Anaconda method OR the pip method, as described below.