/telescope_baseline_fork2

Baseline design study of the JASMINE telescope.

Primary LanguagePython

Baseline study of the JASMINE telescope

This respository provides documents and tools to define the baseline design of the JASMINE telescope. Type the following lines to install telescope_baseline package in your environment.

$ git clone git@github.com:JASMINE-Mission/telescope_baseline.git
$ cd telscope_baseline
$ git checkout develop
$ git pull
$ python setup.py install

Contents

The repository consists of the following components.

  • src/telescope_baseline
  • examples
  • snippets
  • tests

Package Definitions

The directory src/telescope_baseline contains the following directories.

  • data: Several measurements (filter responses etc.)
  • dataclass: Contents in this directory should be moved elsewhere
  • mapping: Functions to construct a mapping strategy.
  • obsplan: Contents in this directory should be moved elsewhere
  • photometry: Functions to estiamte a S/N ration in photometry.
  • tools: Elementary classes.
    • efficiency: Provides the Filters class.
    • mission: Provides the Parameters class.
  • utils: Contents in this directory should be moved elsewhere

Examples

Example codes are stored in this directory.

Snippets

Snippets to prepare data and to generate images are stored in snippets.

Tests

Test cases are provided in the tests directory. We use pytest to check the code itegrity. Install pytest via pip and type the following line to test the code. Do not forget to test the code before making a pull request.

$ cd tests
$ pytest