Installation

Requires: Unix-like operating system (Linux (Ubuntu, CentOS…), Mac), python 3.8, pip, gfortran, make

The installation can be carried out in a conda environment using the below steps.

1. Install gfortran and make. See here.

• Linux:

  sudo apt update
  sudo apt install build-essential`
  

  sudo apt install build-essential installs additional useful utilities like gcc, g++ and make

  If gfortran is not installed with build-essention, please run sudo apt install gfortran

• Mac: brew install gcc and brew install make

2. Have conda installed using the Miniconda or Anaconda distributions.

3. Create and activate a new conda environment with python. Install pip in the environment.

   conda create --name foo python=3.8
   conda activate foo
   conda install pip
   

4. Run make from the root repo directory.

   All the dependencies are automatically installed. If any errors are encountered please check that the following dependencies are installed:

   • numpy

   • pandas

   • scipy

   • lowtran==2.4.1 (requires gfortran)

   • sphinx

   • sphinx_rtd_theme==0.5.2

   • metpy

   • netCDF4

   • astropy

5. Run tests using the make runtest command and get the OK message.

6. Find the documentation in: instrupy/docs/_build/html/user_json_desc.html

Windows

If using a Windows system, one may consider:

1. Setting up a virtual-machine with Ubuntu (or similar) OS.

   See tutorial here How to run Ubuntu desktop on a virtual machine using virtualbox

   Virtual machines:

   • VMware Workstation player is available free for non-commercial, personal or home use. VMWare tools may need to be installed separately after the player installation.

   • Oracle Virtual Box.

2. Using Windows Subsytem for Linux (WSL)

   https://ubuntu.com/wsl

   https://docs.microsoft.com/en-us/windows/wsl/about

The present version of OrbitPy has been tested on Ubuntu 18.04.3.