/instrument_pkg_template

A Python package template for instruments compatible with the SWxSOC processing pipeline

Primary LanguagePython

instrument_pkg_template

A Python package template for instruments compatible with the SWxSOC processing pipeline

To use this template, first install cookiecutter then run

cookiecutter gh:swxsoc/instrument_pkg_template.git

Answer the prompts. If provided a mission name "helios" and instrument 'boo', then cookiecutter will create a new directory called helios_boo.

Go into this directory and run

git init

This is required by setuptools_scm to be able to derive the version number automatically. You can then install for the package for development with

pip install -e .

This template depends on sunpy as well as astropy so you'll have to install them as well.

For other dependencies such as developer dependencies see the pyproject.toml file.