Skip to content

SNflows/flows

Repository files navigation

Flows Pipeline

https://github.com/rhandberg/flows/actions/workflows/tests.yml/badge.svg?branch=devel https://img.shields.io/codecov/c/github/rhandberg/flows Hits-of-Code license

Installation instructions

  • Go to the directory where you want the Python code to be installed and simply download it or clone it via git as:

    >>> git clone https://github.com/rhandberg/flows.git .
    
  • All dependencies can be installed using the following command. It is recommended to do this in a dedicated virtualenv or similar:

    >>> pip install -r requirements.txt
  • Last step is to create a config-file. Create a file named "config.ini" and place it in the "flows" directory. Make sure that the file can only be read by you (chmod 0600 config.ini)! This file can contain all the settings for running the pipeline. A minimal file for working with the pipeline is

    [api]
    token = <my api token>
    
    [TNS]
    api_key = <AUFLOWS_BOT API key>

    Where your API token can be found on the Flows webpage.

How to run tests

You can test your installation by going to the root directory where you cloned the repository and run the command:

>>> pytest

Full configuration file

Text coming soon...

[api]
token =
photometry_cache =

[photometry]
archive_local =
output =

[casjobs]
wsid =
password =

[TNS]
api_key =
bot_id =
bot_name =
user_id =
user_name =

[ztf]
output_photometry =

[database]
username =
password =