Skip to content

mirarenee/InterPython_Workshop_Example

 
 

Repository files navigation

Introduction

This is a template software project repository used by the Intermediate Python for Astronomical Software Development.

LcAnalyzer

Continuous Integration build in GitHub Actions LcAnalyzer is a package written in Python that allows you to inspect light curves.

Main features

Here are some key features of LcAnalyzer:

  • Reading CSV and Pickle files;
  • Giving the list of unique objects present in the data;
  • Selecting observations of a given star in a given bands;

Prerequisites

LcAnalyzer requires the following Python packages:

  • Pandas - makes use of Pandas's data types and statistical functions
  • Matplotlib - uses Matplotlib to generate statistical plots

The following optional packages are required to run LcAnalyzer's unit tests:

  • pytest - LcAnalyzer's unit tests are written using pytest
  • pytest-cov - Adds test coverage stats to unit testing

Purpose

This repository is intended to be used as a code template which is copied by learners at Intermediate Python for Astronomical Software Development course. This can be done using the Fork button towards the top right of this repo's GitHub page.

This software project is not finished, is currently failing to run and contains some code style issues. It is used as a starting point for the course - issues will be fixed and code will be added in a number of places during the course by learners in their own copies of the repository, as course topics are introduced.

Tests

Several tests have been implemented already, some of which are currently failing. These failing tests set out the requirements for the additional code to be implemented during the workshop.

About

A template of software project for the Intermediate Python for Astronomical Software Development workshop

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Jupyter Notebook 85.5%
  • Python 14.5%