INSTALLATION GUIDE

[TOC]

Installation with CONDA

# 1. get source code
cd <dir_put_VNSIM>
git clone https://github.com/ZhenZHAO/VNSIM.git
# 2. config env
cd VNSIM/Installation
conda env create -f environment.yaml
conda env list
source activate enVNSIM  # "activate enVNSIM" on Windows
cd ..
# 3. test
python Func_uv.py -h
python Func_uv.py -g
python Func_obs.py -g -s -i -f png

If no errors show up, you are good to go.

Installation with PIP

You must successfully install python (version 3.6 or about) and corresponding pip

# 0. install python 3.6 and pip
...
# 1. get source code
cd <dir_put_VNSIM>
git clone https://github.com/ZhenZHAO/VNSIM.git

# 2. config env with packages
cd VNSIM/Installation
pip install -r requirements.txt
cd ..
# 3. Testing
python Func_uv.py -h
python Func_uv.py -g
python Func_obs.py -g -s -i -f png

If no errors show up, you are good to go.

Trouble-Shooting:

RuntimeError: Python is not installed as a framework. The Mac OS X backend will not be able to function correctly if Python is not installed as a framework.

The please specify the backends of matplotlib in the code, add the following code at the beginning of the script,

import matplotlib as mpl
mpl.use("TkAgg")

Modules used in VNSIM

• VNSIM is developed under the environment of Python 3.6, and the following modules are used.
• If you don't want to mess with your own environment, please make sure the following packets are installed.
  • os
  • sys
  • pickle
  • argparse
  • configparser
  • numpy
  • scipy
  • matplotlib
  • astropy
  • time
  • tkinter
  • sqlite3
  • multiprocessing
  • threading
  • queue
  • logging
  • webbrowser