cnb-tools 0.1.0

Convenience tools/functions for challenges and benchmarking on Synapse.org

Convenience tools/functions for challenges and benchmarking on Synapse.org

---

📖 Documentation: https://sage-bionetworks-challenges.github.io/cnb-tools

👾 Source code: https://github.com/Sage-Bionetworks-Challenges/cnb-tools

---

cnb-tools is a set of tools and commands that provides an interface for managing crowd-sourced challenges hosted on Synapse.org, including but not limited to, DREAM Challenges.

Requirements

• Python 3.9+
• Synapse account

To fully utilize cnb-tools, you must have a Synapse account and provide your credentials to the tool. To do so, create a .synapseConfig file in your home directory, and enter the following:

[authentication]
authtoken = "YOUR PAT"

Generate a new Synapse Personal Access Token (PAT) with all token permissions enabled, then copy-paste it into authtoken. Save the file.

For security, we recommend updating its permissions so that other users on your machine do not have read access to your credentials, e.g.

$ chmod 600 ~/.synapseConfig

Installation

$ pip install cnb-tools

[!NOTE] cnb-tools builds off of the Synapse Python Client — by installing cnb-tools, you will also be installing synapseclient.

→ Read its docs.

Verify the installation with:

$ cnb-tools --version
cnb-tools v0.1.0

License

cnb-tools is released under the Apache 2.0 license.