Skip to content

Commit

Permalink
Merge pull request #1 from willrogers/tidying
Browse files Browse the repository at this point in the history
Rename PYTAC to Pytac.
  • Loading branch information
willrogers committed May 24, 2017
2 parents d4d89a0 + df67e9d commit 819e751
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ pytac/#*
*.swp
*.swo
*~

# documentation
docs/_build
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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`.
10 changes: 5 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
4 changes: 2 additions & 2 deletions docs/intro.rst
Original file line number Diff line number Diff line change
@@ -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`_.


Expand Down

0 comments on commit 819e751

Please sign in to comment.