============== Flows Pipeline

.. image:: https://zenodo.org/badge/241705955.svg :target: https://zenodo.org/badge/latestdoi/241705955 .. image:: https://github.com/SNflows/flows/actions/workflows/tests.yml/badge.svg?branch=devel :target: https://github.com/SNflows/flows/actions/workflows/tests.yml .. image:: https://codecov.io/github/SNflows/flows/branch/devel/graph/badge.svg?token=H8CQGPG0U6 :target: https://codecov.io/github/SNflows/flows .. image:: https://hitsofcode.com/github/SNflows/flows?branch=devel :alt: Hits-of-Code :target: https://hitsofcode.com/view/github/SNflows/flows?branch=devel .. image:: https://img.shields.io/github/license/SNflows/flows.svg :alt: license :target: https://github.com/SNflows/flows/blob/devel/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/SNflows/flows.git .

• Required dependencies can be installed using the following command. It is recommended to do this in a dedicated virtualenv <https://virtualenv.pypa.io/en/stable/>_ or similar:

  pip install -r requirements.txt pip install -r requirements_dev.txt # for tests/development

• Changed with tendrils API. If using tendrils, follow the steps below, but then let tendrils know of the config file location. Alternatively, individual config file elements can be set programatically using tendrils and will be saved to a config file automatically. 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

  .. code-block:: ini

  [api] token =

  [TNS] 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...

.. code-block:: ini

[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 =

Making a release
================

• Bump sem-version when Devel is ready to merge in file = VERSION (v1.0.0). Checkout devel. Edit Version. Push devel.
• Merge Devel into Master (Create PR from Devel -> Master), wait until tests are passing. Create issues if not. Then Merge.
• Create tag on Master corresponding to right semversion. This means, checkout master. Pull master locally. Create tag using git tag called "v1.0.0" or whatever the sem-version. Push local tag to GitHub.
• Merge Master into devel to propagate tag (Create PR on GitHub).
• Create release on GH releases tab if all tests passing.