There are two ways to submit a new tool.

All submitted content will be licensed under the CC BY-SA license. Under this license, everyone, including you, can access and use the content on this website freely. Please don’t submit anything if you don’t agree with this license.

On how to use the content, please refer to the About page.

Using Our Form

We have created a form for you to submit new tools. We will regularly collect the results and integrate them into our website. Click the button below to submit a tool. All submissions are listed on this trello board.

We need a name so we can address in the database that it was you who added the tool. Please consider avoiding your real name since this will be public. If you would like to link to your own website, please also provide a link to your personal website so that people can reach you though the link.

bullet list is recommended, i.e.,
- This is features one
- This is feature two
- ...

We have a few predefined tags already. Feel free to choose "Other" option and specify after.

Upload a cover screenshot if you like

We pull data from this form automatically and create a Pull Request on GitHub. Not every tool will be merged. The unmerged tools will be shown in the list of PRs.

OR Create a Pull Request on GitHub

If your are familiar with GitHub, please create a new Pull Request here: kausalflow/tools

We use Hugo to generate the website.

  1. Install Hugo
  2. Fork the repo kausalflow/tools
  3. hugo new tools/name-of-tool.md
  4. Edit the new file in content/tools/name-of-tools.md
  5. Commit, Push, and Create PR on GitHub

If you prefer not to install Hugo:

  1. Fork the repo kausalflow/tools
  2. Create a new file content/tools/name-of-tool.md with the following content
     0
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

    ---
title: # Name of the tool
images: # Create a folder in /static/images/tools that has the same name as this current markdown file and place the images there. We only need the file name here. If this is not clear, please refer to existing tools as references.
  - path: # only the file name
categories:
  -
tags:
  -
links: # Links related to the tool
  - name:
    link:
summary:
features: # list of features
  -
platforms: # the platforms that the tool runs on. e.g., Web, Min, Mac, Android, iOS
  - ""
fields: # the field of science that this tool is mostly used in
  - ""
plans: # fees
  - name:
    description:
makers: # the makers of the tool
  - name:
    description:
author:      # the person who submitted this tool to KausalFlow
date:   # current date in iso-format
draft: false
---
  3. Fill in the fields in the new file. If it is unclear what to type in, please refer to existing tools inside content/tools/.
  4. Commit, Push, and Create PR on GitHub.

If one would like to generate the list of images for the markdown metadata, awk helps. For example, for all images of kroki, one could use

ls static/images/tools/kroki | awk '{print "  - path: \""$0"\""}'