From 367a566db3d2f31f3fe84280b42e969707265f62 Mon Sep 17 00:00:00 2001 From: Will Rogers Date: Wed, 24 May 2017 14:12:42 +0100 Subject: [PATCH 1/2] Rename PYTAC to Pytac. --- .gitignore | 3 +++ README.md | 2 +- docs/index.rst | 10 +++++----- docs/intro.rst | 4 ++-- 4 files changed, 11 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index d11460a4..df7e5a25 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,6 @@ pytac/#* *.swp *.swo *~ + +# documentation +docs/_build diff --git a/README.md b/README.md index 316e516b..cb155bdf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![Build Status](https://travis-ci.org/simkimsia/UtilityBehaviors.png)](https://travis-ci.org/simkimsia/UtilityBehaviors) [![Coverage Status](https://coveralls.io/repos/github/willrogers/pytac/badge.svg?branch=master)](https://coveralls.io/github/willrogers/pytac?branch=master) [![Health](https://landscape.io/github/willrogers/pytac/master/landscape.svg?style=flat)](https://landscape.io/github/willrogers/pytac/) [![Documentation Status](https://readthedocs.org/projects/pytac/badge/?version=latest)](http://pytac.readthedocs.io/en/latest/?badge=latest) -Python Toolkit for Accelerator Controls (PYTAC) is a Python library intended to make it easy to work with particle accelerators. +Python Toolkit for Accelerator Controls (Pytac) is a Python library intended to make it easy to work with particle accelerators. ## Testing diff --git a/docs/index.rst b/docs/index.rst index 5b7263a6..99372fff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,17 +3,17 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. include:: intro.rst -Welcome to PYTAC's documentation! -================================= -PYTAC is a python library for accelerator commissioning and beam study. +Python Toolkit for Accelerator Controls +======================================= +Python Toolkit for Accelerator Controls (Pytac) is a python library for accelerator commissioning and beam study. -It is a framework that implements high level configure/run behaviour of control system components.PYTAC includes a set of API (Application Programming Interface) which is used for writing further scripts and interactive controls. The function of Python Middle Layer is to provide a scripting language for on-line control, including non-EPICS based control systems. +It is a framework that implements high level configure/run behaviour of control system components. Pytac includes a set of API (Application Programming Interface) which is used for writing further scripts and interactive controls. The function of Python Middle Layer is to provide a scripting language for on-line control, including non-EPICS based control systems. Software Overview ================= -Python Toolkit for Accelerator Controls (PYTAC) provides a library of software that communicates with machine hardware for online applications. It is important to note that although the online get/set routines originally communicated via EPICS Channel Access they can now communicate with a variety of control systems. There are only two core functions that need to be re-programmed to work with the new control system - get and put inside the ControlSystem class. +Pytac provides a library of software that communicates with machine hardware for online applications. It is important to note that although the online get/set routines originally communicated via EPICS Channel Access they can now communicate with a variety of control systems. There are only two core functions that need to be re-programmed to work with the new control system - get and put inside the ControlSystem class. diff --git a/docs/intro.rst b/docs/intro.rst index 8e065b7a..63942533 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -1,7 +1,7 @@ -What can PYTAC do? +What can Pytac do? ------------------ -PYTAC provides a layer on top of `EPICS`_ +Pytac provides a layer on top of `EPICS`_ that wraps up groups of `PVs`_. From df67e9d7fb14ca9cff8986f1bfb5415d81e78d88 Mon Sep 17 00:00:00 2001 From: Will Rogers Date: Wed, 24 May 2017 14:14:23 +0100 Subject: [PATCH 2/2] Tidy readme. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb155bdf..32437501 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,6 @@ To see a coverage report: To build documentation correctly: -Change current directory to docs +* `cd docs` * `sphinx-build -b html -E . _build/html` -The documentation is build inside _build/html +The documentation is built inside `_build/html`.