Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mike-jt79 committed Jan 28, 2021
1 parent b44a4e0 commit fa0bd9f
Show file tree
Hide file tree
Showing 63 changed files with 18,994 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file added docs/build/doctrees/commands.doctree
Binary file not shown.
Binary file added docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/build/doctrees/faq.doctree
Binary file not shown.
Binary file added docs/build/doctrees/getting_started.doctree
Binary file not shown.
Binary file added docs/build/doctrees/index.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9883a4ae18685b16d8f9e36efd2e5f18
tags: 645f666f9bcd5a90fca523b33c5a78b7
48 changes: 48 additions & 0 deletions docs/build/html/_sources/commands.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Usage
*****
Running ``epic`` will list the available commands::

>epic
Usage: epic [OPTIONS] COMMAND [ARGS]...

CLI for communicating with the EPIC

Options:
--config TEXT Configuration file to load (default is ~/.epic/config)
--help Show this message and exit.

Commands:
cluster Cluster Management
configure Configure the CLI tool
data Data Management
job Manage your EPIC jobs
project Project Management
team Team Management

You can get more detailed help by adding the ``--help`` option::

>epic data download --help
_____ ____ ___ ____ _ _____ _ _
| ____| _ \_ _/ ___| | |__ _ _ |__ /___ _ __ ___ | |_ ___ ___| |__
| _| | |_) | | | | '_ \| | | | / // _ \ '_ \ / _ \| __/ _ \/ __| '_ \
| |___| __/| | |___ | |_) | |_| | / /| __/ | | | (_) | || __/ (__| | | |
|_____|_| |___\____| |_.__/ \__, | /____\___|_| |_|\___/ \__\___|\___|_| |_|
|___/

Loading config from /Users/user/.epic/config
Usage: epic data download [OPTIONS] SOURCE DESTINATION

Download a file from EPIC SOURCE to local DESTINATION SOURCE should be
prefixed with "epic://"

Example, download EPIC file from /my_sim_data/my.file to directory ./work/

"epiccli sync download epic://my_sim_data/my.file ./work/"

to download whole folders use 'sync'.

Options:
-f Overwrite file if it exists locally
--help Show this message and exit.


6 changes: 6 additions & 0 deletions docs/build/html/_sources/faq.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
FAQ
***

Q. How can I request more features in EPIC Cli? .

A. We're always happy to recieve new feature requests. Please contact us at zenotech.com.
21 changes: 21 additions & 0 deletions docs/build/html/_sources/getting_started.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Installation
************

Python 3.4+ is required. The package can be installed from PyPi using pip.

``pip install epiccli``


Authentication
**************

To use the API you will need an 'API token'. This can be retieved by logging into EPIC and viewing the API Token section on the Your Profile -> Your Credentials page.
Once you have a token you can configure the CLI by running:

``epic configure``

This will pronpt you for the url of EPIC, the default will suit most cases, and your API token. This configuration will then write this information to a config file stored in your user home.

Next time you use EPIC Cli it will load the token from that configration file. You can override this by using the ``--config`` option to load a different configuration file.

Alternatively you can supply your token directly by setting the EPIC_TOKEN environment variable.
12 changes: 12 additions & 0 deletions docs/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
EPIC CLI
********

EPIC CLI is a simple python based command line tool for interacting with `EPIC <https://epic.zenotech.com/>`_ .
It is built using the EPIC Python SDK `pyepic <https://pypi.org/project/pyepic/>`_ .

Contents
********
.. toctree::
getting_started
commands
faq
Loading

0 comments on commit fa0bd9f

Please sign in to comment.