Skip to main content

A CLI tool for cataloging pilot 1 data

Project description

Globus Pilot

https://readthedocs.org/projects/globus-pilot/badge/?version=latest&style=flat https://github.com/globusonline/globus-pilot/actions/workflows/tests.yml/badge.svg https://img.shields.io/pypi/v/globus-pilot.svg https://img.shields.io/pypi/wheel/globus-pilot.svg License

A Command Line tool for managing data in Globus Search as well as transferring corresponding data to and from a Globus Endpoint.

Installation

Pilot requires python 3.6+, you can install with the following:

pip install globus-pilot

See the Read-The-Docs Page for more options.

Quick Start

For a full walkthrough, see the User Guide. Administrators can also view the Admin Guide.

A quick walkthrough is below.

First, login using Globus:

pilot login

Set your Search Index:

pilot index set <myindex>

Then choose your project. See pilot project info for info on any listed project:

pilot project
pilot project set <myproject>

You can use list to get a high level overview of the data:

pilot list

If you want more detail about a specific search record, you can use describe to view details:

pilot describe dose_response/rescaled_combined_single_drug_growth

You can also download the data associated with the search record:

pilot download dose_response/rescaled_combined_single_drug_growth

When you want to add more data to the collection, you can use the upload command. This will upload the data in addition to creating a record in Globus Search to track it.

touch my_data.tsv
pilot upload my_data.tsv test_dir --dry-run --verbose -j my_metadata.json

The two flags ‘–dry-run –verbose’ are optional but handy for testing. ‘-j my_metadata.json’ is for providing any extra metadata the pilot tool can’t automatically determine. Here is an example of the metadata:

{
    "title": "Drug Identifiers",
    "description": "Drug identifiers, including InChIKey, SMILES, and PubChem.",
    "data_type": "Drug Response",
    "dataframe_type": "List",
    "source": [
        "InChIKey",
        "SMILES",
        "PubChem"
    ]
}

Running Tests

Ensure packages in test-requirements.txt are installed, then run:

pytest

And for coverage:

pytest --cov pilot

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

globus-pilot-0.7.0.tar.gz (74.5 kB view hashes)

Uploaded Source

Built Distribution

globus_pilot-0.7.0-py3-none-any.whl (95.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page