Table of Contents

1. Introduction
2. Installation
   1. Prerequisite
   2. Installing SpecDAL
   3. Development version
3. Features
   1. Example usage (TODO)

Introduction

SpecDAL is a Python package for loading and manipulating field spectroscopy data. It currently supports readers for ASD, SVC, and PSR spectremeters. SpecDAL provides useful functions for processing and aggregating the data.

Installation

Currently, SpecDAL can be installed from Github. We plan to make it available via Python's pip installer in the future.

Prerequisite

1. Install Python 3
   • packages: pandas, numpy, matplotlib, etc.
2. Install Git
3. (Windows only) Install Git-bash.

Installing SpecDAL

1. Open terminal or Git-bash and navigate to the desired directory using cd <directory>.

2. The following command will create a directory SpecDAL-code containing SpecDAL:

   git clone https://github.com/EnSpec/SpecDAL-code.git
   

3. To update the package, go to SpecDAL-code directory and run the following command:

   git pull origin master
   

Development version

Development version is maintained in dev branch and production version in master. For the latest development version, run the following code:

git fetch origin
git branch dev

Features

At its core, SpecDAL package provides python functions and data structures to manipulate spectroscopy data in specdal. Python users can import the modules directly to write their own scripts.

We also provide interface via command-line pipeline and GUI in bin.

Example usage (TODO)